com.google.api.services.docs.v1.model

Class Person

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.docs.v1.model.Person

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Person
extends com.google.api.client.json.GenericJson

A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address.

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 Docs 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

com.google.api.client.util.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
Person()

Method Summary

Modifier and Type	Method and Description
Person	clone()
String	getPersonId() Output only.
PersonProperties	getPersonProperties() Output only.
List<String>	getSuggestedDeletionIds() IDs for suggestions that remove this person link from the document.
List<String>	getSuggestedInsertionIds() IDs for suggestions that insert this person link into the document.
Map<String,SuggestedTextStyle>	getSuggestedTextStyleChanges() The suggested text style changes to this Person, keyed by suggestion ID.
TextStyle	getTextStyle() The text style of this Person.
Person	set(String fieldName, Object value)
Person	setPersonId(String personId) Output only.
Person	setPersonProperties(PersonProperties personProperties) Output only.
Person	setSuggestedDeletionIds(List<String> suggestedDeletionIds) IDs for suggestions that remove this person link from the document.
Person	setSuggestedInsertionIds(List<String> suggestedInsertionIds) IDs for suggestions that insert this person link into the document.
Person	setSuggestedTextStyleChanges(Map<String,SuggestedTextStyle> suggestedTextStyleChanges) The suggested text style changes to this Person, keyed by suggestion ID.
Person	setTextStyle(TextStyle textStyle) The text style of this Person.

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

Person

public Person()

Method Detail

getPersonId

public String getPersonId()

Output only. The unique ID of this link.

Returns:

value or null for none

setPersonId

public Person setPersonId(String personId)

Output only. The unique ID of this link.

Parameters:

personId - personId or null for none

getPersonProperties

public PersonProperties getPersonProperties()

Output only. The properties of this Person. This field is always present.

Returns:

value or null for none

setPersonProperties

public Person setPersonProperties(PersonProperties personProperties)

Output only. The properties of this Person. This field is always present.

Parameters:

personProperties - personProperties or null for none

getSuggestedDeletionIds

public List<String> getSuggestedDeletionIds()

IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.

Returns:

value or null for none

setSuggestedDeletionIds

public Person setSuggestedDeletionIds(List<String> suggestedDeletionIds)

IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.

Parameters:

suggestedDeletionIds - suggestedDeletionIds or null for none

getSuggestedInsertionIds

public List<String> getSuggestedInsertionIds()

IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.

Returns:

value or null for none

setSuggestedInsertionIds

public Person setSuggestedInsertionIds(List<String> suggestedInsertionIds)

IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.

Parameters:

suggestedInsertionIds - suggestedInsertionIds or null for none

getSuggestedTextStyleChanges

public Map<String,SuggestedTextStyle> getSuggestedTextStyleChanges()

The suggested text style changes to this Person, keyed by suggestion ID.

Returns:

value or null for none

setSuggestedTextStyleChanges

public Person setSuggestedTextStyleChanges(Map<String,SuggestedTextStyle> suggestedTextStyleChanges)

The suggested text style changes to this Person, keyed by suggestion ID.

Parameters:

suggestedTextStyleChanges - suggestedTextStyleChanges or null for none

getTextStyle

public TextStyle getTextStyle()

The text style of this Person.

Returns:

value or null for none

setTextStyle

public Person setTextStyle(TextStyle textStyle)

The text style of this Person.

Parameters:

textStyle - textStyle or null for none

set

public Person set(String fieldName,
                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Person clone()

Overrides:

clone in class com.google.api.client.json.GenericJson