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

Class RichLink

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.RichLink

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event).

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
RichLink()

Method Summary

Modifier and Type	Method and Description
RichLink	clone()
String	getRichLinkId() Output only.
RichLinkProperties	getRichLinkProperties() Output only.
List<String>	getSuggestedDeletionIds() IDs for suggestions that remove this link from the document.
List<String>	getSuggestedInsertionIds() IDs for suggestions that insert this link into the document.
Map<String,SuggestedTextStyle>	getSuggestedTextStyleChanges() The suggested text style changes to this RichLink, keyed by suggestion ID.
TextStyle	getTextStyle() The text style of this RichLink.
RichLink	set(String fieldName, Object value)
RichLink	setRichLinkId(String richLinkId) Output only.
RichLink	setRichLinkProperties(RichLinkProperties richLinkProperties) Output only.
RichLink	setSuggestedDeletionIds(List<String> suggestedDeletionIds) IDs for suggestions that remove this link from the document.
RichLink	setSuggestedInsertionIds(List<String> suggestedInsertionIds) IDs for suggestions that insert this link into the document.
RichLink	setSuggestedTextStyleChanges(Map<String,SuggestedTextStyle> suggestedTextStyleChanges) The suggested text style changes to this RichLink, keyed by suggestion ID.
RichLink	setTextStyle(TextStyle textStyle) The text style of this RichLink.

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

RichLink

public RichLink()

Method Detail

getRichLinkId

public String getRichLinkId()

Output only. The ID of this link.

Returns:

value or null for none

setRichLinkId

public RichLink setRichLinkId(String richLinkId)

Output only. The ID of this link.

Parameters:

richLinkId - richLinkId or null for none

getRichLinkProperties

public RichLinkProperties getRichLinkProperties()

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

Returns:

value or null for none

setRichLinkProperties

public RichLink setRichLinkProperties(RichLinkProperties richLinkProperties)

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

Parameters:

richLinkProperties - richLinkProperties or null for none

getSuggestedDeletionIds

public List<String> getSuggestedDeletionIds()

IDs for suggestions that remove this link from the document. A RichLink 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 RichLink setSuggestedDeletionIds(List<String> suggestedDeletionIds)

IDs for suggestions that remove this link from the document. A RichLink 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 link into the document. A RichLink 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 RichLink setSuggestedInsertionIds(List<String> suggestedInsertionIds)

IDs for suggestions that insert this link into the document. A RichLink 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 RichLink, keyed by suggestion ID.

Returns:

value or null for none

setSuggestedTextStyleChanges

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

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

Parameters:

suggestedTextStyleChanges - suggestedTextStyleChanges or null for none

getTextStyle

public TextStyle getTextStyle()

The text style of this RichLink.

Returns:

value or null for none

setTextStyle

public RichLink setTextStyle(TextStyle textStyle)

The text style of this RichLink.

Parameters:

textStyle - textStyle or null for none

set

public RichLink set(String fieldName,
                    Object value)

Overrides:

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

clone

public RichLink clone()

Overrides:

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