Class CoursesResource.ListRequest

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first.

This method returns the following error codes:

  • PERMISSION_DENIED for access errors. * INVALID_ARGUMENT if the query argument is malformed. * NOT_FOUND if any users specified in the query arguments do not exist.
Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<ListCoursesResponse>
ClassroomBaseServiceRequest<ListCoursesResponse>
CoursesResource.ListRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Classroom.v1
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class ListRequest : ClassroomBaseServiceRequest<ListCoursesResponse>, IClientServiceRequest<ListCoursesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

Declaration
public ListRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

CourseStates

Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.

Declaration
[RequestParameter("courseStates", RequestParameterType.Query)]
public virtual CoursesResource.ListRequest.CourseStatesEnum? CourseStates { get; set; }
Property Value
Type Description
System.Nullable<CoursesResource.ListRequest.CourseStatesEnum>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListCoursesResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListCoursesResponse>.MethodName

PageSize

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.

The server may return fewer than the specified number of results.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PageToken

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListCoursesResponse>.RestPath

StudentId

Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following:

  • the numeric identifier for the user * the email address of the user * the string literal &quot;me&quot;, indicating the requesting user
Declaration
[RequestParameter("studentId", RequestParameterType.Query)]
public virtual string StudentId { get; set; }
Property Value
Type Description
System.String

TeacherId

Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following:

  • the numeric identifier for the user * the email address of the user * the string literal &quot;me&quot;, indicating the requesting user
Declaration
[RequestParameter("teacherId", RequestParameterType.Query)]
public virtual string TeacherId { get; set; }
Property Value
Type Description
System.String

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Classroom.v1.ClassroomBaseServiceRequest<Google.Apis.Classroom.v1.Data.ListCoursesResponse>.InitParameters()

Implements