Interface AuthContextType

Represents the authentication context type for React context providers.

Source

export interface AuthContextType {
  authState: AuthState;
  login: (credentials: APICredentials) => Promise<void>;
  refreshToken: () => Promise<void>;
  logout: () => void;
  cancelAuth: () => Promise<void>;
  isLoading: boolean;
  error: string | null;
  statusMessage: string | null;
  setCredentialSource: (source: "default" | "custom") => void;
  updateCustomCredentials: (
    clientId: string,
    clientSecret: string,
    redirectUri: string,
  ) => void;
  customCredentials: APICredentials | null;
}
interface AuthContextType {
    authState: AuthState;
    login: (credentials: APICredentials) => Promise<void>;
    refreshToken: () => Promise<void>;
    logout: () => void;
    cancelAuth: () => Promise<void>;
    isLoading: boolean;
    error: null | string;
    statusMessage: null | string;
    setCredentialSource: (source: "default" | "custom") => void;
    updateCustomCredentials: (
        clientId: string,
        clientSecret: string,
        redirectUri: string,
    ) => void;
    customCredentials: null | APICredentials;
}

Properties

authState login refreshToken logout cancelAuth isLoading error statusMessage setCredentialSource updateCustomCredentials customCredentials

Properties

authState

authState: AuthState

The current authentication state.

login

login: (credentials: APICredentials) => Promise<void>

Function to log in with credentials.

refreshToken

refreshToken: () => Promise<void>

Function to refresh the authentication token.

logout

logout: () => void

Function to log out the user.

cancelAuth

cancelAuth: () => Promise<void>

Function to cancel an in-progress authentication flow.

isLoading

isLoading: boolean

Whether an authentication operation is in progress.

error

error: null | string

The current authentication error message, if any.

statusMessage

statusMessage: null | string

The current status message, if any.

setCredentialSource

setCredentialSource: (source: "default" | "custom") => void

Function to set the credential source.

updateCustomCredentials

updateCustomCredentials: (
    clientId: string,
    clientSecret: string,
    redirectUri: string,
) => void

Function to update custom credentials.

customCredentials

customCredentials: null | APICredentials

The current custom credentials, if any.

Settings

Member Visibility

On This Page

Properties