Class UserProfilesResource.GuardianInvitationsResource.ListRequest

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.

This method returns the following error codes:

  • PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian invitations for that student, if "-" is specified as the student_id and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). May also be returned if an invalid page_token or state is provided. * NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of that student.
Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<ListGuardianInvitationsResponse>
ClassroomBaseServiceRequest<ListGuardianInvitationsResponse>
UserProfilesResource.GuardianInvitationsResource.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<ListGuardianInvitationsResponse>, IClientServiceRequest<ListGuardianInvitationsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, String)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string studentId)
Parameters
Type Name Description
IClientService service
System.String studentId

Properties

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.ListGuardianInvitationsResponse>.HttpMethod

InvitedEmailAddress

If specified, only results with the specified invited_email_address will be returned.

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

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.ListGuardianInvitationsResponse>.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.ListGuardianInvitationsResponse>.RestPath

States

If specified, only results with the specified state values will be returned. Otherwise, results with a state of PENDING will be returned.

Declaration
[RequestParameter("states", RequestParameterType.Query)]
public virtual UserProfilesResource.GuardianInvitationsResource.ListRequest.StatesEnum? States { get; set; }
Property Value
Type Description
System.Nullable<UserProfilesResource.GuardianInvitationsResource.ListRequest.StatesEnum>

StudentId

The ID of the student whose guardian invitations are to be returned. 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 * the string literal &quot;-&quot;, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.
Declaration
[RequestParameter("studentId", RequestParameterType.Path)]
public virtual string StudentId { get; }
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.ListGuardianInvitationsResponse>.InitParameters()

Implements