Type Alias AppPlatformClient

Type Declaration

• Readonlypasswordless: PasswordlessAuth

• createSocket: function

  • createSocket(socketConfig?: Omit<SocketConfig, "params">): Socket

    Phoenix ApiSocket using the current access token + publishable key. Throws if not signed in.

    Parameters

    • OptionalsocketConfig: Omit<SocketConfig, "params">

    Returns Socket

• getSession: function

  • getSession(): AppSession | null

    Returns AppSession | null

• restore: function

  • restore(): Promise<AppSession | null>

    Hydrate from storage and wire auto-refresh. Returns session if any.

    Returns Promise<AppSession | null>

• signIn: function

  • signIn(
        tokens: AuthTokens,
        user?:
            | {
                alias?: string
                | null;
                email?: string | null;
                id: string;
                name?: string | null;
                org?: string | null;
                org_name?: string | null;
                org_role?: string | null;
            }
            | null,
    ): Promise<AppSession>

    Apply tokens from a login/verify response and persist.

    Parameters

    • tokens: AuthTokens
    • Optionaluser:
          | {
              alias?: string
              | null;
              email?: string | null;
              id: string;
              name?: string | null;
              org?: string | null;
              org_name?: string | null;
              org_role?: string | null;
          }
          | null

    Returns Promise<AppSession>

• signOut: function

  • signOut(): Promise<void>

    Clear memory + storage + client tokens.

    Returns Promise<void>