TwilioSyncTokenOptions
Defined in: lib/token/twilio-token.interface.ts:103
Options for a Sync token.
https://www.twilio.com/docs/sync
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
endpointId? |
string |
Identifies this specific device or browser tab. | - | lib/token/twilio-token.interface.ts:107 |
identity |
string |
Identity the token represents, normally a username in your system. Voice tokens accept only alphanumeric characters and underscores; this is enforced when minting a Voice token. | TwilioTokenOptions.identity |
lib/token/twilio-token.interface.ts:34 |
nbf? |
number |
Epoch seconds before which the token is not accepted. | TwilioTokenOptions.nbf |
lib/token/twilio-token.interface.ts:44 |
region? |
string |
Twilio Region for the token. Currently honoured for Voice tokens only. See https://www.twilio.com/docs/global-infrastructure/understanding-twilio-regions | TwilioTokenOptions.region |
lib/token/twilio-token.interface.ts:51 |
serviceSid? |
string |
Sync Service SID. Starts with IS. |
- | lib/token/twilio-token.interface.ts:105 |
ttl? |
number |
Lifetime in seconds. Defaults to the SDK’s 3600. Twilio caps tokens at 24 hours (86400), and recommends the shortest lifetime your application can tolerate. | TwilioTokenOptions.ttl |
lib/token/twilio-token.interface.ts:41 |