Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
PerformAppServiceInteraction

PerformAppServiceInteraction Class Reference

Constructors

Instance Methods

Constructors

new PerformAppServiceInteraction(parameters)

Initalizes an instance of PerformAppServiceInteraction.

Instance Methods

performAppServiceInteraction.getOriginApp() ⇒ String

Get the OriginApp

Kind: Instance method of PerformAppServiceInteraction
Returns: String - the KEY_ORIGIN_APP value

performAppServiceInteraction.getRequestServiceActive() ⇒ Boolean

Get the RequestServiceActive

Kind: Instance method of PerformAppServiceInteraction
Returns: Boolean - the KEY_REQUEST_SERVICE_ACTIVE value

performAppServiceInteraction.getServiceID() ⇒ String

Get the ServiceID

Kind: Instance method of PerformAppServiceInteraction
Returns: String - the KEY_SERVICE_ID value

performAppServiceInteraction.getServiceUri() ⇒ String

Get the ServiceUri

Kind: Instance method of PerformAppServiceInteraction
Returns: String - the KEY_SERVICE_URI value

performAppServiceInteraction.setOriginApp(app) ⇒ PerformAppServiceInteraction

Set the OriginApp

Kind: Instance method of PerformAppServiceInteraction
Returns: PerformAppServiceInteraction - The class instance for method chaining.

ParamTypeDescription
app String This string is the appID of the app requesting the app service provider take the specific - The desired OriginApp. action.

performAppServiceInteraction.setRequestServiceActive(active) ⇒ PerformAppServiceInteraction

Set the RequestServiceActive

Kind: Instance method of PerformAppServiceInteraction
Returns: PerformAppServiceInteraction - The class instance for method chaining.

ParamTypeDescription
active Boolean This flag signals the requesting consumer would like this service to become the active - The desired RequestServiceActive. primary service of the destination's type.

performAppServiceInteraction.setServiceID(id) ⇒ PerformAppServiceInteraction

Set the ServiceID

Kind: Instance method of PerformAppServiceInteraction
Returns: PerformAppServiceInteraction - The class instance for method chaining.

ParamTypeDescription
id String The service ID that the app consumer wishes to send this URI. - The desired ServiceID.

performAppServiceInteraction.setServiceUri(uri) ⇒ PerformAppServiceInteraction

Set the ServiceUri

Kind: Instance method of PerformAppServiceInteraction
Returns: PerformAppServiceInteraction - The class instance for method chaining.

ParamTypeDescription
uri String Fully qualified URI based on a predetermined scheme provided by the app service. SDL makes - The desired ServiceUri. no guarantee that this URI is correct.
View on GitHub.com
Previous Section Next Section