VideoObjectBuilder

public final class VideoObjectBuilder extends IndexableBuilder<VideoObjectBuilder>

Builder to construct an Indexable for a video object.

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

Public Method Summary

VideoObjectBuilder
setAuthor(PersonBuilder author)
Sets the author of the video object.
VideoObjectBuilder
setDuration(long durationInSeconds)
Sets the duration of the video object in seconds.
VideoObjectBuilder
setDurationWatched(long durationWatchedInSeconds)
Sets the duration of the video object which the user has already watched in seconds.
VideoObjectBuilder
setLocationCreated(PlaceBuilder place)
Sets the place where the video was taken.
VideoObjectBuilder
setSeriesName(String seriesName)
Sets the series name this video object belongs to.
VideoObjectBuilder
setUploadDate(Date uploadDate)
Sets the date when this video object was uploaded.

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 VideoObjectBuilder setAuthor (PersonBuilder author)

Sets the author of the video object.

Parameters
author The author of the video object.

public VideoObjectBuilder setDuration (long durationInSeconds)

Sets the duration of the video object in seconds.

Parameters
durationInSeconds The duration of the video object in seconds.

public VideoObjectBuilder setDurationWatched (long durationWatchedInSeconds)

Sets the duration of the video object which the user has already watched in seconds.

Parameters
durationWatchedInSeconds The duration of the video object which the user has already watched in seconds. The value must be less than or equal to the value used in setDuration(long).

public VideoObjectBuilder setLocationCreated (PlaceBuilder place)

Sets the place where the video was taken.

public VideoObjectBuilder setSeriesName (String seriesName)

Sets the series name this video object belongs to. The name can represent a channel name, a subscription name or a playlist name.

Parameters
seriesName The series name this video object belongs to.

public VideoObjectBuilder setUploadDate (Date uploadDate)

Sets the date when this video object was uploaded.

Parameters
uploadDate The date when this video object was uploaded.