ping-identity
    Preparing search index...

    Type Alias JourneyClient

    Native-backed Journey client contract.

    type JourneyClient = {
        dispose: () => Promise<void>;
        getId: () => Promise<string>;
        init: () => Promise<string>;
        logoutUser: () => Promise<boolean>;
        next: (input?: JourneyNextInput) => Promise<JourneyNode>;
        refresh: () => Promise<JourneyUserSession | null>;
        resume: (uri: string) => Promise<JourneyNode>;
        revoke: () => Promise<boolean>;
        ssoToken: () => Promise<JourneySSOToken | null>;
        start: (
            journeyName: string,
            options?: JourneyStartOptions,
        ) => Promise<JourneyNode>;
        user: () => Promise<JourneyUserSession | null>;
        userinfo: () => Promise<JourneyUserInfo | null>;
    }
    Index

    Properties

    dispose getId init logoutUser next refresh resume revoke ssoToken start user userinfo

    Properties

    dispose: () => Promise<void>

    Dispose the native Journey instance and release runtime state.

    Type Declaration

      • (): Promise<void>

      • Returns Promise<void>

        Promise resolved when disposal completes.

    When disposal fails.

    getId: () => Promise<string>

    Returns the native Journey instance identifier.

    Type Declaration

      • (): Promise<string>

      • Returns Promise<string>

        Native Journey instance identifier.

    When the Journey is not configured.

    init: () => Promise<string>

    Explicitly initialize the native Journey instance.

    Type Declaration

      • (): Promise<string>

      • Returns Promise<string>

        Native Journey instance identifier.

    When the Journey cannot be configured.

    logoutUser: () => Promise<boolean>

    Logout active Journey user/session.

    Type Declaration

      • (): Promise<boolean>

      • Returns Promise<boolean>

        true when logout succeeds.

    When logout fails.

    next: (input?: JourneyNextInput) => Promise<JourneyNode>

    Advance an active Journey by applying callback input.

    Type Declaration

    When callback application or progression fails.

    refresh: () => Promise<JourneyUserSession | null>

    Refresh active Journey user access token.

    Type Declaration

    When refresh fails.

    resume: (uri: string) => Promise<JourneyNode>

    Resume a suspended Journey flow from a deep link URL.

    Type Declaration

      • (uri: string): Promise<JourneyNode>

      • Parameters

        • uri: string

          Resume URI provided by native/server.

        Returns Promise<JourneyNode>

        Resumed Journey node.

    When resume fails.

    revoke: () => Promise<boolean>

    Revoke active Journey user access/refresh tokens.

    Type Declaration

      • (): Promise<boolean>

      • Returns Promise<boolean>

        true when revoke completes.

    When revoke fails.

    ssoToken: () => Promise<JourneySSOToken | null>

    Resolve active Journey SSO token payload.

    Type Declaration

    When SSO token retrieval fails.

    start: (
        journeyName: string,
        options?: JourneyStartOptions,
    ) => Promise<JourneyNode>

    Start a Journey by name.

    Type Declaration

    When start fails.

    user: () => Promise<JourneyUserSession | null>

    Resolve active user session details.

    Type Declaration

    When session retrieval fails.

    userinfo: () => Promise<JourneyUserInfo | null>

    Resolve active Journey userinfo claims.

    Type Declaration

    When userinfo retrieval fails.

    Settings

    Member Visibility

    On This Page

    Properties