DigitalDocumentBuilder

public final class DigitalDocumentBuilder extends IndexableBuilder<DigitalDocumentBuilder>

Builder to construct an Indexable for a digital document of different types.

For reference, see: //schema.org/DigitalDocument.

Public Method Summary

DigitalDocumentBuilder
setAuthor(PersonBuilder... personBuilders)
Sets authors of the digital document.
DigitalDocumentBuilder
setDateCreated(Date dateCreated)
Sets the date on which the digital document was created.
DigitalDocumentBuilder
setDateModified(Date dateModified)
Sets the date on which the digital document was last edited.
DigitalDocumentBuilder
setHasDigitalDocumentPermission(DigitalDocumentPermissionBuilder... permissions)
Sets the permission related to the access to this digital document (e.g. permission to read or write).
DigitalDocumentBuilder
setText(String text)
Sets the textual content of the digital document.

Inherited Method Summary

com.google.firebase.appindexing.builders.IndexableBuilder
final Indexable
build()
Finalize building the object.
T
put(String key, boolean... values)
Sets one or multiple boolean values for a property, replacing its previous values.
<S extends IndexableBuilder<?>> T
put(String key, S... values)
Sets one or multiple Indexable values for a property.
T
put(String key, Indexable... values)
Sets one or multiple Indexable values for a property, replacing its previous values.
T
put(String key, String... values)
Sets one or multiple string values for a property, replacing its previous values.
T
put(String key, long... values)
Sets one or multiple long values for a property, replacing its previous values.
T
setAlternateName(String... alternateNames)
Sets the alternate names for the content.
final T
setDescription(String description)
Sets the optional description of the content.
T
setId(String id)
Sets the ID for the Indexable.
final T
setImage(String url)
Sets the image of the content.
final <S extends IndexableBuilder<?>> T
setIsPartOf(S... collections)
Sets the sub-group or collection that this Indexable is part of.
final T
setKeywords(String... keywords)
Sets the keywords of the Indexable.
T
setMetadata(Indexable.Metadata.Builder metadataBuilder)
Sets the metadata.
final T
setName(String name)
Sets the name of the content, must not be null.
final T
setSameAs(String webUrl)
Sets the corresponding web URL.
final T
setUrl(String url)
Sets the URL.
Object
clone()
boolean
equals(Object arg0)
void
finalize()
final Class<?>
getClass()
int
hashCode()
final void
notify()
final void
notifyAll()
String
toString()
final void
wait(long arg0, int arg1)
final void
wait(long arg0)
final void
wait()

Public Methods

public DigitalDocumentBuilder setAuthor (PersonBuilder... personBuilders)

Sets authors of the digital document.

Parameters
personBuilders The authors of this digital document.

public DigitalDocumentBuilder setDateCreated (Date dateCreated)

Sets the date on which the digital document was created.

Parameters
dateCreated The date on which the digital document was created.

public DigitalDocumentBuilder setDateModified (Date dateModified)

Sets the date on which the digital document was last edited.

Parameters
dateModified The date on which the digital document was last edited.

public DigitalDocumentBuilder setHasDigitalDocumentPermission (DigitalDocumentPermissionBuilder... permissions)

Sets the permission related to the access to this digital document (e.g. permission to read or write). For a public digital document, specify a grantee with an Audience with audienceType equal to "public".

Parameters
permissions The permissions related to the access to this digital document.

public DigitalDocumentBuilder setText (String text)

Sets the textual content of the digital document.

Parameters
text The textual content of the digital document.