Webcom Android SDK Public API Reference / com.orange.webcom.sdkv2.datasync / Descriptor

Descriptor

class Descriptor

Represents the specifications of a Subscription.

Constructors

<init>

Descriptor(type: Type, includesRevocation: Boolean = true, expirationDate: Long? = null, encryptionAlgorithm: CryptoMethod = CryptoMethod.None, constraint: Constraint = Constraint.None)

Represents the specifications of a Subscription.

Properties

constraint

val constraint: Constraint

Additional constraint on the type of event to subscribe to, which makes it possible to filter the subscribed data.

encryptionAlgorithm

val encryptionAlgorithm: CryptoMethod

Algorithm to use to encrypt notifications (no encryption if not set). This setting is mandatory for Notification targets.

expirationDate

val expirationDate: Long?

Deadline for the subscription (or infinite if not set). This setting is mandatory for Webhook and Notification targets.

includesRevocation

val includesRevocation: Boolean

Set to true to be notified when the subscription is revoked by the Webcom back end.

type

val type: Type

The type of event to subscribe to.