Class CoursesResource.StudentsResource.ListRequest

Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * NOT_FOUND if the course does not exist. * PERMISSION_DENIED for access errors.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<ListStudentsResponse>
ClassroomBaseServiceRequest<ListStudentsResponse>
CoursesResource.StudentsResource.ListRequest
Implements
Google.Apis.Requests.IClientServiceRequest<ListStudentsResponse>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.GetBody()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.ListStudentsResponse>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
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<ListStudentsResponse>, IClientServiceRequest<ListStudentsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, String)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string courseId)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
System.String courseId

Properties

CourseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Declaration
[RequestParameter("courseId", RequestParameterType.Path)]
public virtual string CourseId { get; }
Property Value
Type Description
System.String

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.ListStudentsResponse>.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.ListStudentsResponse>.MethodName

PageSize

Maximum number of items to return. The default is 30 if unspecified or 0. 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.ListStudentsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

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

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest