LiveKit JS Server SDK - v2.13.3
    Preparing search index...

    Interface AccessTokenOptions

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

    Properties

    attributes? identity? metadata? name? ttl?

    Properties

    attributes?: Record<string, string>

    custom participant attributes

    identity?: string

    identity of the user, required for room join tokens

    metadata?: string

    custom participant metadata

    name?: string

    display name for the participant, available as Participant.name

    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