Classroom.UserProfiles.GuardianInvitations.Create (Google Classroom API v1-rev20220319-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.classroom.ClassroomRequest<GuardianInvitation>
        
        com.google.api.services.classroom.Classroom.UserProfiles.GuardianInvitations.Create

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Classroom.UserProfiles.GuardianInvitations
```
public class Classroom.UserProfiles.GuardianInvitations.Create
extends ClassroomRequest<GuardianInvitation>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Create(String studentId, GuardianInvitation content)` Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getStudentId()` ID of the student (in standard format)
`Classroom.UserProfiles.GuardianInvitations.Create`	`set(String parameterName, Object value)`
`Classroom.UserProfiles.GuardianInvitations.Create`	`set$Xgafv(String $Xgafv)` V1 error format.
`Classroom.UserProfiles.GuardianInvitations.Create`	`setAccessToken(String accessToken)` OAuth access token.
`Classroom.UserProfiles.GuardianInvitations.Create`	`setAlt(String alt)` Data format for response.
`Classroom.UserProfiles.GuardianInvitations.Create`	`setCallback(String callback)` JSONP
`Classroom.UserProfiles.GuardianInvitations.Create`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Classroom.UserProfiles.GuardianInvitations.Create`	`setKey(String key)` API key.
`Classroom.UserProfiles.GuardianInvitations.Create`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Classroom.UserProfiles.GuardianInvitations.Create`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Classroom.UserProfiles.GuardianInvitations.Create`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Classroom.UserProfiles.GuardianInvitations.Create`	`setStudentId(String studentId)` ID of the student (in standard format)
`Classroom.UserProfiles.GuardianInvitations.Create`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Classroom.UserProfiles.GuardianInvitations.Create`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.classroom.ClassroomRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Create
```
protected Create(String studentId,
                 GuardianInvitation content)
```
    Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user. Create a request for the method "guardianInvitations.create". This request holds the parameters needed by the the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Classroom.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    studentId - ID of the student (in standard format)
    
    content - the GuardianInvitation
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Classroom.UserProfiles.GuardianInvitations.Create set$Xgafv(String $Xgafv)
```
    Description copied from class: ClassroomRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ClassroomRequest<GuardianInvitation>
  - setAccessToken
```
public Classroom.UserProfiles.GuardianInvitations.Create setAccessToken(String accessToken)
```
    Description copied from class: ClassroomRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ClassroomRequest<GuardianInvitation>
  - setAlt
```
public Classroom.UserProfiles.GuardianInvitations.Create setAlt(String alt)
```
    Description copied from class: ClassroomRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ClassroomRequest<GuardianInvitation>
  - setCallback
```
public Classroom.UserProfiles.GuardianInvitations.Create setCallback(String callback)
```
    Description copied from class: ClassroomRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ClassroomRequest<GuardianInvitation>
  - setFields
```
public Classroom.UserProfiles.GuardianInvitations.Create setFields(String fields)
```
    Description copied from class: ClassroomRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ClassroomRequest<GuardianInvitation>
  - setKey
```
public Classroom.UserProfiles.GuardianInvitations.Create setKey(String key)
```
    Description copied from class: ClassroomRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class ClassroomRequest<GuardianInvitation>
  - setOauthToken
```
public Classroom.UserProfiles.GuardianInvitations.Create setOauthToken(String oauthToken)
```
    Description copied from class: ClassroomRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ClassroomRequest<GuardianInvitation>
  - setPrettyPrint
```
public Classroom.UserProfiles.GuardianInvitations.Create setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ClassroomRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ClassroomRequest<GuardianInvitation>
  - setQuotaUser
```
public Classroom.UserProfiles.GuardianInvitations.Create setQuotaUser(String quotaUser)
```
    Description copied from class: ClassroomRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class ClassroomRequest<GuardianInvitation>
  - setUploadType
```
public Classroom.UserProfiles.GuardianInvitations.Create setUploadType(String uploadType)
```
    Description copied from class: ClassroomRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ClassroomRequest<GuardianInvitation>
  - setUploadProtocol
```
public Classroom.UserProfiles.GuardianInvitations.Create setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ClassroomRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ClassroomRequest<GuardianInvitation>
  - getStudentId
```
public String getStudentId()
```
    ID of the student (in standard format)
  - setStudentId
```
public Classroom.UserProfiles.GuardianInvitations.Create setStudentId(String studentId)
```
    ID of the student (in standard format)
  - set
```
public Classroom.UserProfiles.GuardianInvitations.Create set(String parameterName,
                                                             Object value)
```
    Overrides:
    
    set in class ClassroomRequest<GuardianInvitation>

Class Classroom.UserProfiles.GuardianInvitations.Create

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.classroom.ClassroomRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Create

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getStudentId

setStudentId

set