oracle.maf.api.platform.ios

Class SiriShortcut

Object

oracle.maf.api.platform.ios.SiriShortcut

public class SiriShortcut
extends Object

Bean class representing a Siri shortcut This class is used to create a new siri shortcut. It is also used by APIs that allow retrieving and setting the available shortcuts. Siri shortcuts are relevant only on iOS.

Constructor Summary

Constructors

Constructor and Description
SiriShortcut()

Method Summary

Modifier and Type	Method and Description
String	getActivityType() Returns the siri shortcut activity type.
String	getPersistentIdentifier() Gets the persistent identifier for the shortcut The persistent identifier is used to uniquely identify a shortcut across permutations.
String	getSuggestedInvocationPhrase() Gets the suggested invocation phrase.
String	getSystemIdentifier() Gets the shortcut system identifier The system identifier is assigned by iOS when a shortcut is added.
String	getTitle() Returns the title of the shortcut
java.util.Map<String,Object>	getUserInfo() Gets a user map of values that are persisted with the shortcut and delivered with the shortcut's invocation.
boolean	isEligibleForPrediction()
boolean	isEligibleForSearch()
void	setEligibleForPrediction(boolean isEligibleForPrediction) Sets whether Siri can suggest the user activity as a shortcut to the user.
void	setEligibleForSearch(boolean isEligibleForSearch) Sets whether the shortcut can returned during device searches
void	setPersistentIdentifier(String persistentIdentifier) Sets the persistent identifier for the shortcut The persistent identifier is used to uniquely identify a shortcut across permutations.
void	setSuggestedInvocationPhrase(String suggestedInvocationPhrase) Sets the suggested invocation phrase.
void	setSystemIdentifier(String systemIdentifier) Sets the system identifier for the shortcut The system identifier is assigned by iOS when a shortcut is added.
void	setTitle(String title) Set the shortcut title
void	setUserInfo(java.util.Map<String,Object> userInfo) Sets a user map of values that are persisted with the shortcut and delivered with the shortcut's invocation.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiriShortcut

public SiriShortcut()

Method Detail

getActivityType

public String getActivityType()

Returns the siri shortcut activity type. This will always be the application's id with the suffix ".shortcut"

Returns:

the activity type

setPersistentIdentifier

public void setPersistentIdentifier(String persistentIdentifier)

Sets the persistent identifier for the shortcut The persistent identifier is used to uniquely identify a shortcut across permutations. It is recommended that all shortcuts created have a unique persistent identifier specified.

Parameters:

persistentIdentifier - The persistent identifier

getPersistentIdentifier

public String getPersistentIdentifier()

Gets the persistent identifier for the shortcut The persistent identifier is used to uniquely identify a shortcut across permutations. It is recommended that all shortcuts created have a unique persistent identifier specified.

Returns:

the persistent identifier

setTitle

public void setTitle(String title)

Set the shortcut title

Parameters:

title - the new title

getTitle

public String getTitle()

Returns the title of the shortcut

Returns:

the shortcut title

setSuggestedInvocationPhrase

public void setSuggestedInvocationPhrase(String suggestedInvocationPhrase)

Sets the suggested invocation phrase. The system displays the suggested invocation phrase to the user when they create the shortcut. Use a short, memorable phrase, such as "Soup time".

Parameters:

suggestedInvocationPhrase - the suggested invocation phrase

getSuggestedInvocationPhrase

public String getSuggestedInvocationPhrase()

Gets the suggested invocation phrase. The system displays the suggested invocation phrase to the user when they create the shortcut. Use a short, memorable phrase, such as "Soup time".

Returns:

the suggested invocation phrase

setEligibleForSearch

public void setEligibleForSearch(boolean isEligibleForSearch)

Sets whether the shortcut can returned during device searches

Parameters:

isEligibleForSearch - whether the shortcut appears in search results

isEligibleForSearch

public boolean isEligibleForSearch()

Returns:

whether the shortcut can be returned during device searches

setEligibleForPrediction

public void setEligibleForPrediction(boolean isEligibleForPrediction)

Sets whether Siri can suggest the user activity as a shortcut to the user. Defaults to true

Parameters:

isEligibleForPrediction - whether eligible for prediction

isEligibleForPrediction

public boolean isEligibleForPrediction()

Returns:

Sets whether Siri can suggest the user activity as a shortcut to the user.

setUserInfo

public void setUserInfo(java.util.Map<String,Object> userInfo)

Sets a user map of values that are persisted with the shortcut and delivered with the shortcut's invocation. Object values should be instances of String, Integer, Double, or Boolean.

Parameters:

userInfo - The map of user info to store with the shortcut. May be null.

getUserInfo

public java.util.Map<String,Object> getUserInfo()

Gets a user map of values that are persisted with the shortcut and delivered with the shortcut's invocation. Object values should be instances of String, Integer, Double, or Boolean.

Returns:

The associated map. May be null.

setSystemIdentifier

public void setSystemIdentifier(String systemIdentifier)

Sets the system identifier for the shortcut The system identifier is assigned by iOS when a shortcut is added. Use this system identifier when editing or deleting a shortcut already created.

Parameters:

systemIdentifier - sytem identifer

getSystemIdentifier

public String getSystemIdentifier()

Gets the shortcut system identifier The system identifier is assigned by iOS when a shortcut is added. Use this system identifier when editing or deleting a shortcut already created.

Returns:

the system identifier. May be null.