Action.Builder

public static class Action.Builder extends Object

Known Direct Subclasses

The builder for Action.

Constant Summary

String	ACTIVATE_ACTION	The act of starting or activating something.
String	ADD_ACTION	The act of editing by adding something to a collection (e.g. an item to a shopping cart or movie to a queue).
String	BOOKMARK_ACTION	The act of bookmarking something (e.g. an article or song).
String	COMMENT_ACTION	The act of commenting on something (e.g. an article or social media post).
String	LIKE_ACTION	The act of liking something (e.g. a book, song or article).
String	LISTEN_ACTION	The act of listening to something (e.g. music or a podcast).
String	SEND_ACTION	The act of sending a message.
String	SHARE_ACTION	The act of sharing something (e.g. a document or social media post)
String	STATUS_TYPE_ACTIVE	The status of an active action (i.e. an action that has started but not yet completed).
String	STATUS_TYPE_COMPLETED	The status of a completed action.
String	STATUS_TYPE_FAILED	The status of a failed action.
String	VIEW_ACTION	The act of viewing something (e.g. an article or profile).
String	WATCH_ACTION	The act of watching something (e.g. a video, movie or TV show).

Public Constructor Summary

Builder(String type)

The constructor.

Public Method Summary

Action	build() Builds the action.
Action.Builder	put(String key, double... values) Sets one or multiple double values for a property, replacing its previous values.
Action.Builder	put(String key, boolean... values) Sets one or multiple boolean values for a property, replacing its previous values.
Action.Builder	put(String key, Indexable... values) Sets one or multiple `Indexable` values for a property, replacing its previous values.
Action.Builder	put(String key, String... values) Sets one or multiple string values for a property, replacing its previous values.
Action.Builder	put(String key, long... values) Sets one or multiple long values for a property, replacing its previous values.
Action.Builder	setActionStatus(String actionStatus) Sets the status of the action.
Action.Builder	setMetadata(Action.Metadata.Builder metadataBuilder) Sets the metadata for this action.
final Action.Builder	setName(String name) Sets the name of the action (e.g. Ride using Waymo LLC).
Action.Builder	setObject(String name, String url, String webUrl) Sets the object that the action is taken on (e.g. the article being viewed, or the song being listened to).
Action.Builder	setObject(String name, String url) Sets the object that the action is taken on (e.g. the article being viewed, or the song being listened to).
Action.Builder	setResult(Indexable... values) Sets the result of the action.
final Action.Builder	setUrl(String url) Sets the URL of the action.

Inherited Method Summary

From class java.lang.Object

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 ACTIVATE_ACTION

The act of starting or activating something.

Constant Value: "ActivateAction"

public static final String ADD_ACTION

The act of editing by adding something to a collection (e.g. an item to a shopping cart or movie to a queue).

Constant Value: "AddAction"

public static final String BOOKMARK_ACTION

The act of bookmarking something (e.g. an article or song).

Constant Value: "BookmarkAction"

public static final String COMMENT_ACTION

The act of commenting on something (e.g. an article or social media post).

Constant Value: "CommentAction"

public static final String LIKE_ACTION

The act of liking something (e.g. a book, song or article).

Constant Value: "LikeAction"

public static final String LISTEN_ACTION

The act of listening to something (e.g. music or a podcast).

Constant Value: "ListenAction"

public static final String SEND_ACTION

The act of sending a message.

Constant Value: "SendAction"

public static final String SHARE_ACTION

The act of sharing something (e.g. a document or social media post)

Constant Value: "ShareAction"

public static final String STATUS_TYPE_ACTIVE

The status of an active action (i.e. an action that has started but not yet completed).

Constant Value: "//schema.org/ActiveActionStatus"

public static final String STATUS_TYPE_COMPLETED

The status of a completed action.

Constant Value: "//schema.org/CompletedActionStatus"

public static final String STATUS_TYPE_FAILED

The status of a failed action.

Constant Value: "//schema.org/FailedActionStatus"

public static final String VIEW_ACTION

The act of viewing something (e.g. an article or profile).

Constant Value: "ViewAction"

public static final String WATCH_ACTION

The act of watching something (e.g. a video, movie or TV show).

Constant Value: "WatchAction"

Public Constructors

public Builder (String type)

The constructor.

Parameters

type	The Schema.org type best describing this action (use one of the constants on this class, or refer to //schema.org/Action for a list of standard action types).

Public Methods

public Action build ()

Builds the action.

public Action.Builder put (String key, double... values)

Sets one or multiple double values for a property, replacing its previous values.

Parameters

key	The property. Must not be null.
values	The double values of the property.

public Action.Builder put (String key, boolean... values)

Sets one or multiple boolean values for a property, replacing its previous values.

Parameters

key	The property. Must not be null.
values	The boolean values of the property.

public Action.Builder put (String key, Indexable... values)

Sets one or multiple Indexable values for a property, replacing its previous values.

Parameters

key	The schema.org property. Must not be null.
values	The values represented as an `Indexable`. Null values are ignored. `Indexable`s must be constructed using `Indexable.Builder` or convenience methods.

Throws

FirebaseAppIndexingInvalidArgumentException

public Action.Builder put (String key, String... values)

Sets one or multiple string values for a property, replacing its previous values.

Parameters

key	The property. Must not be null.
values	The string values of the property. Null values are ignored.

public Action.Builder put (String key, long... values)

Sets one or multiple long values for a property, replacing its previous values.

Parameters

key	The property. Must not be null.
values	The long values of the property.

public Action.Builder setActionStatus (String actionStatus)

Sets the status of the action. Optional.

public Action.Builder setMetadata (Action.Metadata.Builder metadataBuilder)

Sets the metadata for this action. Optional.

public final Action.Builder setName (String name)

Sets the name of the action (e.g. Ride using Waymo LLC).

public Action.Builder setObject (String name, String url, String webUrl)

Sets the object that the action is taken on (e.g. the article being viewed, or the song being listened to).

Parameters

name	The name of the object (e.g. the title of an article, or name of a song). Must not be null.
url	The URL of the object (this URL needs to be handled by the app to take the user to the right place). Must be a valid URL.
webUrl	The web URL of the object, if different from `url`. Must be a valid URL.

public Action.Builder setObject (String name, String url)

Sets the object that the action is taken on (e.g. the article being viewed, or the song being listened to).

Parameters

name	The name of the object (e.g. the title of an article, or name of a song). Must not be null.
url	The URL of the object (this URL needs to be handled by the app to take the user to the right place). Must be a valid URL.

public Action.Builder setResult (Indexable... values)

Sets the result of the action. Optional.

Parameters

values	Results of performing the action.

Throws

FirebaseAppIndexingInvalidArgumentException

public final Action.Builder setUrl (String url)

Sets the URL of the action.

Must match Object URL when both are set.

Parameters

url	The URL to start an activity to (re)perform the action. Must be a valid URL.