DigitalDocumentPermissionBuilder

public final class DigitalDocumentPermissionBuilder extends IndexableBuilder<DigitalDocumentPermissionBuilder>

Builder to construct an Indexable for a permission on a digital document.

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

Constant Summary

String COMMENT_PERMISSION The permission to comment on a digital document (does not imply the permission to read or modify it).
String READ_PERMISSION The permission to read a digital document.
String WRITE_PERMISSION The permission to modify a digital document.

Public Method Summary

DigitalDocumentPermissionBuilder
setGrantee(PersonBuilder... grantees)
Sets the grantees who get the permission to access.
DigitalDocumentPermissionBuilder
setPermissionType(String type)
Sets the type of access permission.

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

Constants

public static final String COMMENT_PERMISSION

The permission to comment on a digital document (does not imply the permission to read or modify it).

Constant Value: "CommentPermission"

public static final String READ_PERMISSION

The permission to read a digital document.

Constant Value: "ReadPermission"

public static final String WRITE_PERMISSION

The permission to modify a digital document.

Constant Value: "WritePermission"

Public Methods

public DigitalDocumentPermissionBuilder setGrantee (PersonBuilder... grantees)

Sets the grantees who get the permission to access.

Parameters
grantees The grantees who get the permission to access.

public DigitalDocumentPermissionBuilder setPermissionType (String type)

Sets the type of access permission.

Parameters
type The type of access permission.