Interface AccessTokenOptions

interface AccessTokenOptions {
    attributes?: Record<string, string>;
    identity?: string;
    metadata?: string;
    name?: string;
    ttl?: string | number;
}

Properties

attributes? identity? metadata? name? ttl?

Properties

Optionalattributes

attributes?: Record<string, string>

custom attributes to be passed to participants

Optionalidentity

identity?: string

identity of the user, required for room join tokens

Optionalmetadata

metadata?: string

custom metadata to be passed to participants

Optionalname

name?: string

display name for the participant, available as Participant.name

Optionalttl

ttl?: string | number

amount of time before expiration expressed in seconds or a string describing a time span zeit/ms. eg: '2 days', '10h', or seconds as numeric value

Settings

Member Visibility

On This Page

Properties