Variable TokenSourceConst

Type Declaration

• custom: function

  • custom(customFn: CustomFn): TokenSourceCustom

    TokenSource.custom allows a user to define a manual function which generates new TokenSourceResponseObject values on demand.

    Use this to get credentials from custom backends / etc.

    Parameters

    • customFn: CustomFn

    Returns TokenSourceCustom

• developmentTokenServer: function

  • developmentTokenServer(
        tokenServerId: string,
        options?: DevelopmentTokenServerOptions,
    ): TokenSourceDevelopmentTokenServer

    TokenSource.developmentTokenServer queries a development token server for credentials, which supports quick prototyping / getting started types of use cases.

    This token provider is INSECURE and should NOT be used in production.

    For more info:

    Parameters

    • tokenServerId: string
    • options: DevelopmentTokenServerOptions = {}

    Returns TokenSourceDevelopmentTokenServer

    See

    https://docs.livekit.io/frontends/build/authentication/sandbox-token-server/

• endpoint: function

  • endpoint(url: string, options?: EndpointOptions): TokenSourceEndpoint

    TokenSource.endpoint creates a token source that fetches credentials from a given URL using the standard endpoint format:

    Parameters

    • url: string
    • options: EndpointOptions = {}

    Returns TokenSourceEndpoint

    See

    https://docs.livekit.io/frontends/build/authentication/endpoint/

• literal: function

  • literal(literalOrFn: LiteralOrFn): TokenSourceLiteral

    TokenSource.literal contains a single, literal set of TokenSourceResponseObject credentials, either provided directly or returned from a provided function.

    Parameters

    • literalOrFn: LiteralOrFn

    Returns TokenSourceLiteral

• sandboxTokenServer: function

  • sandboxTokenServer(
        sandboxId: string,
        options?: DevelopmentTokenServerOptions,
    ): TokenSourceSandboxTokenServer

    Parameters

    • sandboxId: string
    • options: DevelopmentTokenServerOptions = {}

    Returns TokenSourceSandboxTokenServer

    Deprecated

    Use TokenSource.developmentTokenServer instead