Class SkyWayAuthToken

Constructors

constructor

Properties

exp iat jti scope tokenString? version?

Methods

encode Decode

Constructors

constructor

  • new SkyWayAuthToken(props): SkyWayAuthToken

  • Parameters

    • props: {
          exp: number;
          iat: number;
          jti: string;
      } & {
          scope: {
              app: {
                  actions?: ("write" | "read" | "listChannels")[];
                  analytics?: boolean;
                  channels?: ({
                      id?: (...) | (...);
                      name?: (...) | (...);
                  } & {
                      actions: (...)[];
                      members: (...)[];
                      sfuBots?: (...) | (...);
                  } & {
                      [k: string]: unknown;
                  })[];
                  id: string;
                  turn?: boolean;
              } & {
                  [k: string]: unknown;
              };
          };
          version?: 1 | 2;
      } | {
          exp: number;
          iat: number;
          jti: string;
      } & {
          scope: {
              analytics?: {
                  enabled?: boolean;
              };
              appId: string;
              rooms: ({
                  id?: string;
                  name?: string;
              } & {
                  member?: {
                      id?: ...;
                      name?: ...;
                  } & {
                      methods: ...;
                  } & {
                      [k: ...]: ...;
                  };
                  methods: ("create" | "updateMetadata" | "close")[];
                  sfu?: {
                      enabled?: (...) | (...) | (...);
                      maxSubscribersLimit?: (...) | (...);
                  };
              } & {
                  [k: string]: unknown;
              })[];
              turn?: {
                  enabled?: boolean;
              };
          } & {
              [k: string]: unknown;
          };
          version: 3;
      }

    Returns SkyWayAuthToken

Properties

exp

exp: number

seconds

iat

iat: number

seconds

jti

jti: string

uuid

Readonly scope

scope: {
    app: {
        actions?: ("write" | "read" | "listChannels")[];
        analytics?: boolean;
        channels?: ({
            id?: string;
            name?: string;
        } & {
            actions: ("create" | "write" | "delete" | "updateMetadata" | "read")[];
            members: ({
                id?: ...;
                name?: ...;
            } & {
                actions: ...;
                publication?: ...;
                subscription?: ...;
            } & {
                [k: ...]: ...;
            })[];
            sfuBots?: objectInputType<(...), (...), (...)>[];
        } & {
            [k: string]: unknown;
        })[];
        id: string;
        turn?: boolean;
    } & {
        [k: string]: unknown;
    };
} | {
    analytics?: {
        enabled?: boolean;
    };
    appId: string;
    rooms: ({
        id?: string;
        name?: string;
    } & {
        member?: {
            id?: string;
            name?: string;
        } & {
            methods: ((...) | (...) | (...))[];
        } & {
            [k: string]: unknown;
        };
        methods: ("create" | "updateMetadata" | "close")[];
        sfu?: {
            enabled?: boolean;
            maxSubscribersLimit?: number;
        };
    } & {
        [k: string]: unknown;
    })[];
    turn?: {
        enabled?: boolean;
    };
} & {
    [k: string]: unknown;
}

Type declaration

  • app: {
        actions?: ("write" | "read" | "listChannels")[];
        analytics?: boolean;
        channels?: ({
            id?: string;
            name?: string;
        } & {
            actions: ("create" | "write" | "delete" | "updateMetadata" | "read")[];
            members: ({
                id?: ...;
                name?: ...;
            } & {
                actions: ...;
                publication?: ...;
                subscription?: ...;
            } & {
                [k: ...]: ...;
            })[];
            sfuBots?: objectInputType<(...), (...), (...)>[];
        } & {
            [k: string]: unknown;
        })[];
        id: string;
        turn?: boolean;
    } & {
        [k: string]: unknown;
    }

Optional tokenString

tokenString?: string

Optional version

version?: 3 | 1 | 2

Methods

encode

  • encode(secret): string

  • Parameters

    • secret: string

    Returns string

Static Decode

Settings

Member Visibility

Theme

On This Page

constructorexpiatjtiscopetokenStringversionencodeDecode