Package com.ringcentral.definitions

Class NotificationDeliveryMode

java.lang.Object

com.ringcentral.definitions.NotificationDeliveryMode

public class NotificationDeliveryMode
extends Object

Notification delivery transport information

Field Summary

Fields

Modifier and Type	Field	Description
String	address	PubNub channel name Required Format: uri Example: 54770517599294_6dda849e
String	certificateName	Certificate name for mobile notification transports Required
String	configName	(Only for an `Internal` transport) The name of internal channel (defined in the backend service configuration) to deliver notifications through.
Boolean	encryption	Optional.
String	encryptionAlgorithm	(Only for a `PubNub` transport, returned only if `encryption` is `true`) Encryption algorithm used Enum: AES
String	encryptionKey	(Only for a `PubNub` transport, returned only if `encryption` is `true`) Cryptographic key to decrypt PubNub notification messages
String	registrationId	Device instance ID for mobile notification transports Required Example: 38b062ae-85f8-4dcc-8734-04d3f7393d42
String	secretKey	(Only for a `PubNub` transport) PubNub credential required to subscribe to the channel Required
String	subscriberKey	(Only for a `PubNub` transport) PubNub credential required to subscribe to the channel Required
String	transportType	The transport type for this subscription Required Enum: WebHook, WebSocket, RC/APNS, RC/GCM, PubNub, Internal

Constructor Summary

Constructors

Constructor	Description
NotificationDeliveryMode()

Method Summary

Modifier and Type	Method	Description
NotificationDeliveryMode	address(String address)
NotificationDeliveryMode	certificateName(String certificateName)
NotificationDeliveryMode	configName(String configName)
NotificationDeliveryMode	encryption(Boolean encryption)
NotificationDeliveryMode	encryptionAlgorithm(String encryptionAlgorithm)
NotificationDeliveryMode	encryptionKey(String encryptionKey)
NotificationDeliveryMode	registrationId(String registrationId)
NotificationDeliveryMode	secretKey(String secretKey)
NotificationDeliveryMode	subscriberKey(String subscriberKey)
NotificationDeliveryMode	transportType(String transportType)

Methods inherited from class java.lang.Object

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

Field Details

transportType

public String transportType

The transport type for this subscription Required Enum: WebHook, WebSocket, RC/APNS, RC/GCM, PubNub, Internal

address

public String address

PubNub channel name Required Format: uri Example: 54770517599294_6dda849e

encryption

public Boolean encryption

Optional. Specifies if notification messages will be encrypted or not. Please note that for some event filters (e.g. presence) encryption is mandatory and `false` value provided by caller will be ignored. Required Enum: false

certificateName

public String certificateName

Certificate name for mobile notification transports Required

registrationId

public String registrationId

Device instance ID for mobile notification transports Required Example: 38b062ae-85f8-4dcc-8734-04d3f7393d42

subscriberKey

public String subscriberKey

(Only for a `PubNub` transport) PubNub credential required to subscribe to the channel Required

secretKey

public String secretKey

(Only for a `PubNub` transport) PubNub credential required to subscribe to the channel Required

encryptionAlgorithm

public String encryptionAlgorithm

(Only for a `PubNub` transport, returned only if `encryption` is `true`) Encryption algorithm used Enum: AES

encryptionKey

public String encryptionKey

(Only for a `PubNub` transport, returned only if `encryption` is `true`) Cryptographic key to decrypt PubNub notification messages

configName

public String configName

(Only for an `Internal` transport) The name of internal channel (defined in the backend service configuration) to deliver notifications through. Required Example: my-server-channel

Constructor Details

NotificationDeliveryMode

public NotificationDeliveryMode()

Method Details

transportType

public NotificationDeliveryMode transportType(String transportType)

address

public NotificationDeliveryMode address(String address)

encryption

public NotificationDeliveryMode encryption(Boolean encryption)

certificateName

public NotificationDeliveryMode certificateName(String certificateName)

registrationId

public NotificationDeliveryMode registrationId(String registrationId)

subscriberKey

public NotificationDeliveryMode subscriberKey(String subscriberKey)

secretKey

public NotificationDeliveryMode secretKey(String secretKey)

encryptionAlgorithm

public NotificationDeliveryMode encryptionAlgorithm(String encryptionAlgorithm)

encryptionKey

public NotificationDeliveryMode encryptionKey(String encryptionKey)

configName

public NotificationDeliveryMode configName(String configName)