oracle.wsc.feature.webrtc.template

Interface NotificationContext

public interface NotificationContext

Method Summary

Modifier and Type	Method and Description
void	dispatch(String payload) Dispatches the message through internal notification gateway if configured.
String	getApplicationId() Get the unique application id depending on the platform for whom the message is intended.
String	getApplicationVersion() Gets the application's version for whom the message is intended.
String	getDeviceToken() Gets the device unique token obtained from the Cloud Provider.
String	getInitiator() Gets the initiator of the triggering message if any.
String	getPackageType() Gets the package for the triggering message
String	getPlatform() Get the platform the application is running on for whom the message is intended.
String	getPlatformVersion() Get the version of the platform the application is running on.
WscProperties	getProperties() Get the properties from the current context.
RestClient	getRestClient() Gets the REST client for submitting outbound REST requests.
String	getTarget() Gets the target of the triggering message if any.
Map<String,Object>	getTriggerMessage() Get the incoming message that triggered this notification.

Method Detail

getInitiator

String getInitiator()

Gets the initiator of the triggering message if any.

Returns:

initiator. e.g. originator for an incoming call.

getTarget

String getTarget()

Gets the target of the triggering message if any.

Returns:

target. e.g. target or B-party for the call.

getPackageType

String getPackageType()

Gets the package for the triggering message

Returns:

package . e.g. call/messaging

getApplicationId

String getApplicationId()

Get the unique application id depending on the platform for whom the message is intended.

Returns:

app-id

getApplicationVersion

String getApplicationVersion()

Gets the application's version for whom the message is intended.

Returns:

version

getPlatform

String getPlatform()

Get the platform the application is running on for whom the message is intended. i.e. Android, iOS, Firefox or Chrome

Returns:

platform

getPlatformVersion

String getPlatformVersion()

Get the version of the platform the application is running on. e.g. 21, 8, 39 or 43

Returns:

version

getDeviceToken

String getDeviceToken()

Gets the device unique token obtained from the Cloud Provider.

Returns:

device token

getTriggerMessage

Map<String,Object> getTriggerMessage()

Get the incoming message that triggered this notification.

Returns:

normalized incoming message.

getRestClient

RestClient getRestClient()

Gets the REST client for submitting outbound REST requests. Only synchronous call outs are allowed in this context.

Returns:

RestClient instance.

dispatch

void dispatch(String payload)

Dispatches the message through internal notification gateway if configured.

Parameters:

payload - payload in the JSON format as shown below. e.g. "data" : { "time": "15:16.2342", "from": "alice@example.com" "message": "Incoming Call" }

getProperties

WscProperties getProperties()

Get the properties from the current context. ex: In groovy it can be accesses as .properties.application.name. List of properties are: name, requestURI, packages

Returns:

current context object.