@twinfinity/core
    Preparing search index...

    Type Alias TwinfinityEmbeddedSessionLoginOptions

    TwinfinityEmbeddedSessionLoginOptions: TwinfinitySessionOptions & {
        cookieAccessPromptStyle?: Partial<CSSStyleDeclaration>;
        cookieAccessPromptText?: string;
        loginFrame?: HTMLIFrameElement;
        loginHint?: string;
        signal?: AbortSignal;
        timeoutMs?: number;
    }

    Type declaration

    • OptionalcookieAccessPromptStyle?: Partial<CSSStyleDeclaration>
    • OptionalcookieAccessPromptText?: string
    • OptionalloginFrame?: HTMLIFrameElement
    • OptionalloginHint?: string
    • Optionalsignal?: AbortSignal

      An optional AbortSignal the caller can use to cancel an in-progress login. Aborting tears down the login iframe and rejects establishEmbedded with a TwinfinitySessionError carrying cause: 'cancelled'. A signal that is already aborted when login starts rejects immediately. Has no effect once the login has settled. See PopupWindowOptions.signal.

    • OptionaltimeoutMs?: number

      Optional upper bound, in milliseconds, on how long the embedded login may take before it rejects with a TwinfinitySessionError carrying cause: 'timeout'. A silent (hidden) iframe login defaults to DEFAULT_SILENT_LOGIN_TIMEOUT_MS because a hidden iframe can't be detected as closed and would otherwise hang forever if the provider never responds. A visible iframe (the cookie-access consent prompt) is not timed out by default, since the user drives it — pass an explicit value to bound it.

    Settings

    Member Visibility