Class AccessToken

Hierarchy

AccessToken

Index

Constructors

constructor

Properties

identity
ttl

Accessors

Methods

Constructors

constructor

new AccessToken(apiKey?: string, apiSecret?: string, options?: AccessTokenOptions): AccessToken

- Defined in AccessToken.ts:40
Creates a new AccessToken

Parameters
- Optional apiKey: string
  
  API Key, can be set in env LIVEKIT_API_KEY
- Optional apiSecret: string
  
  Secret, can be set in env LIVEKIT_API_SECRET
- Optional options: AccessTokenOptions
Returns AccessToken

Properties

Optional identity

identity: string

Optional ttl

ttl: string | number

Accessors

metadata

set metadata(md: string): void

- Defined in AccessToken.ts:86
Set metadata to be passed to the Participant, used only when joining the room

Parameters
- md: string
Returns void

name

set name(name: string): void

- Defined in AccessToken.ts:90
Parameters
- name: string
Returns void

sha256

get sha256(): undefined | string
set sha256(sha: undefined | string): void

- Defined in AccessToken.ts:94
Returns undefined | string
- Defined in AccessToken.ts:98
Parameters
- sha: undefined | string
Returns void

Methods

addGrant

addGrant(grant: VideoGrant): void

- Defined in AccessToken.ts:79
Adds a video grant to this token.

Parameters
- grant: VideoGrant
Returns void

toJwt

toJwt(): string

- Defined in AccessToken.ts:105
Returns string

JWT encoded token

Generated using TypeDoc