Show / Hide Table of Contents

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
object
ClientServiceRequest
ClientServiceRequest<ListStudentsResponse>
ClassroomBaseServiceRequest<ListStudentsResponse>
CoursesResource.StudentsResource.ListRequest
Implements
IClientServiceRequest<ListStudentsResponse>
IClientServiceRequest
Inherited Members
ClassroomBaseServiceRequest<ListStudentsResponse>.Xgafv
ClassroomBaseServiceRequest<ListStudentsResponse>.AccessToken
ClassroomBaseServiceRequest<ListStudentsResponse>.Alt
ClassroomBaseServiceRequest<ListStudentsResponse>.Callback
ClassroomBaseServiceRequest<ListStudentsResponse>.Fields
ClassroomBaseServiceRequest<ListStudentsResponse>.Key
ClassroomBaseServiceRequest<ListStudentsResponse>.OauthToken
ClassroomBaseServiceRequest<ListStudentsResponse>.PrettyPrint
ClassroomBaseServiceRequest<ListStudentsResponse>.QuotaUser
ClassroomBaseServiceRequest<ListStudentsResponse>.UploadType
ClassroomBaseServiceRequest<ListStudentsResponse>.UploadProtocol
ClientServiceRequest<ListStudentsResponse>.Execute()
ClientServiceRequest<ListStudentsResponse>.ExecuteAsStream()
ClientServiceRequest<ListStudentsResponse>.ExecuteAsync()
ClientServiceRequest<ListStudentsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListStudentsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListStudentsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListStudentsResponse>.CreateRequest(bool?)
ClientServiceRequest<ListStudentsResponse>.GenerateRequestUri()
ClientServiceRequest<ListStudentsResponse>.GetBody()
ClientServiceRequest<ListStudentsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListStudentsResponse>.ETagAction
ClientServiceRequest<ListStudentsResponse>.ModifyRequest
ClientServiceRequest<ListStudentsResponse>.ValidateParameters
ClientServiceRequest<ListStudentsResponse>.RequestParameters
ClientServiceRequest<ListStudentsResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Classroom.v1
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class CoursesResource.StudentsResource.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
IClientService service
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
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
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
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
int?

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
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
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
ClassroomBaseServiceRequest<ListStudentsResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In This Article
Back to top Generated by DocFX