PerformAppServiceInteraction Class Reference
Constructors
Instance Methods
- getOriginApp() ⇒
String - getRequestServiceActive() ⇒
Boolean - getServiceID() ⇒
String - getServiceUri() ⇒
String - setOriginApp(app) ⇒
PerformAppServiceInteraction - setRequestServiceActive(active) ⇒
PerformAppServiceInteraction - setServiceID(id) ⇒
PerformAppServiceInteraction - setServiceUri(uri) ⇒
PerformAppServiceInteraction
Constructors
new PerformAppServiceInteraction(parameters)
Initializes 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.
| Param | Type | Description |
|---|---|---|
| app | String |
This string is the appID of the app requesting the app service provider take the specific action. - The desired OriginApp. {'string_min_length': 1} |
performAppServiceInteraction.setRequestServiceActive(active) ⇒ PerformAppServiceInteraction
Set the RequestServiceActive
Kind: Instance method of PerformAppServiceInteraction
Returns: PerformAppServiceInteraction - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| active | Boolean |
This flag signals the requesting consumer would like this service to become the active primary service of the destination's type. - The desired RequestServiceActive. |
performAppServiceInteraction.setServiceID(id) ⇒ PerformAppServiceInteraction
Set the ServiceID
Kind: Instance method of PerformAppServiceInteraction
Returns: PerformAppServiceInteraction - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | String |
The service ID that the app consumer wishes to send this URI. - The desired ServiceID. {'string_min_length': 1} |
performAppServiceInteraction.setServiceUri(uri) ⇒ PerformAppServiceInteraction
Set the ServiceUri
Kind: Instance method of PerformAppServiceInteraction
Returns: PerformAppServiceInteraction - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| uri | String |
Fully qualified URI based on a predetermined scheme provided by the app service. SDL makes no guarantee that this URI is correct. - The desired ServiceUri. {'string_min_length': 1} |