UserProfilesGuardianInvitationsListOptions

import type { UserProfilesGuardianInvitationsListOptions } from "https://googleapis.deno.dev/v1/classroom:v1.ts";

Additional options for Classroom#userProfilesGuardianInvitationsList.

interface UserProfilesGuardianInvitationsListOptions {

invitedEmailAddress?: string;

pageSize?: number;

pageToken?: string;

states?: "GUARDIAN_INVITATION_STATE_UNSPECIFIED" | "PENDING" | "COMPLETE";

}

§Properties

invitedEmailAddress?: string

[src]

If specified, only results with the specified invited_email_address are returned.

pageSize?: number

[src]

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.

pageToken?: string

[src]

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.

states?: "GUARDIAN_INVITATION_STATE_UNSPECIFIED" | "PENDING" | "COMPLETE"

[src]

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