Show / Hide Table of Contents

Class InvitationsResource.ListRequest

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. Note: At least one of user_id or course_id must be supplied. Both fields can be supplied. This method returns the following error codes: * PERMISSION_DENIED for access errors.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListInvitationsResponse>
ClassroomBaseServiceRequest<ListInvitationsResponse>
InvitationsResource.ListRequest
Implements
IClientServiceRequest<ListInvitationsResponse>
IClientServiceRequest
Inherited Members
ClassroomBaseServiceRequest<ListInvitationsResponse>.Xgafv
ClassroomBaseServiceRequest<ListInvitationsResponse>.AccessToken
ClassroomBaseServiceRequest<ListInvitationsResponse>.Alt
ClassroomBaseServiceRequest<ListInvitationsResponse>.Callback
ClassroomBaseServiceRequest<ListInvitationsResponse>.Fields
ClassroomBaseServiceRequest<ListInvitationsResponse>.Key
ClassroomBaseServiceRequest<ListInvitationsResponse>.OauthToken
ClassroomBaseServiceRequest<ListInvitationsResponse>.PrettyPrint
ClassroomBaseServiceRequest<ListInvitationsResponse>.QuotaUser
ClassroomBaseServiceRequest<ListInvitationsResponse>.UploadType
ClassroomBaseServiceRequest<ListInvitationsResponse>.UploadProtocol
ClientServiceRequest<ListInvitationsResponse>.Execute()
ClientServiceRequest<ListInvitationsResponse>.ExecuteAsStream()
ClientServiceRequest<ListInvitationsResponse>.ExecuteAsync()
ClientServiceRequest<ListInvitationsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListInvitationsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListInvitationsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListInvitationsResponse>.CreateRequest(bool?)
ClientServiceRequest<ListInvitationsResponse>.GenerateRequestUri()
ClientServiceRequest<ListInvitationsResponse>.GetBody()
ClientServiceRequest<ListInvitationsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListInvitationsResponse>.ETagAction
ClientServiceRequest<ListInvitationsResponse>.ModifyRequest
ClientServiceRequest<ListInvitationsResponse>.ValidateParameters
ClientServiceRequest<ListInvitationsResponse>.RequestParameters
ClientServiceRequest<ListInvitationsResponse>.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 InvitationsResource.ListRequest : ClassroomBaseServiceRequest<ListInvitationsResponse>, IClientServiceRequest<ListInvitationsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

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

Properties

CourseId

Restricts returned invitations to those for a course with the specified identifier.

Declaration
[RequestParameter("courseId", RequestParameterType.Query)]
public virtual string CourseId { get; set; }
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.ListInvitationsResponse>.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.ListInvitationsResponse>.MethodName

PageSize

Maximum number of items to return. The default is 500 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.ListInvitationsResponse>.RestPath

UserId

Restricts returned invitations to those for a specific user. The identifier can be one of the following:

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
ClassroomBaseServiceRequest<ListInvitationsResponse>.InitParameters()

Implements

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