com.google.api.services.classroom.model

Class Invitation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.classroom.model.Invitation

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Invitation
extends GenericJson

An invitation to join a course.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Classroom API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
Invitation()

Method Summary

Modifier and Type	Method and Description
Invitation	clone()
String	getCourseId() Identifier of the course to invite the user to.
String	getId() Identifier assigned by Classroom.
String	getRole() Role to invite the user to have.
String	getUserId() Identifier of the invited user.
Invitation	set(String fieldName, Object value)
Invitation	setCourseId(String courseId) Identifier of the course to invite the user to.
Invitation	setId(String id) Identifier assigned by Classroom.
Invitation	setRole(String role) Role to invite the user to have.
Invitation	setUserId(String userId) Identifier of the invited user.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

Invitation

public Invitation()

Method Detail

getCourseId

public String getCourseId()

Identifier of the course to invite the user to.

Returns:

value or null for none

setCourseId

public Invitation setCourseId(String courseId)

Identifier of the course to invite the user to.

Parameters:

courseId - courseId or null for none

getId

public String getId()

Identifier assigned by Classroom. Read-only.

Returns:

value or null for none

setId

public Invitation setId(String id)

Identifier assigned by Classroom. Read-only.

Parameters:

id - id or null for none

getRole

public String getRole()

Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.

Returns:

value or null for none

setRole

public Invitation setRole(String role)

Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.

Parameters:

role - role or null for none

getUserId

public String getUserId()

Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

Returns:

value or null for none

setUserId

public Invitation setUserId(String userId)

Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

Parameters:

userId - userId or null for none

set

public Invitation set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public Invitation clone()

Overrides:

clone in class GenericJson