ping-identity
    Preparing search index...

    Type Alias JourneyNode

    JourneyNode: Omit<JourneyInstance, "callbacks"> & {
        callbacks?: JourneyCallback[];
        cause?: string;
        description?: string;
        header?: string;
        input?: Record<string, unknown>;
        message?: string;
        pageFooter?: string;
        stage?: string;
        submitButtonText?: string;
        type?: JourneyNodeType;
    }

    Journey node payload returned by native execution.

    Type Declaration

    • Optionalcallbacks?: JourneyCallback[]

      Callback collection when additional user input is required.

    • Optionalcause?: string

      Optional failure cause message for FailureNode.

    • Optionaldescription?: string

      Optional page description text for ContinueNode payloads.

      Populated only for ContinueNode. On iOS this normalizes the native pageDescription property to this shared field name.

    • Optionalheader?: string

      Optional page header text for ContinueNode payloads.

      Populated only for ContinueNode. On iOS this normalizes the native pageHeader property to this shared field name.

    • Optionalinput?: Record<string, unknown>

      Optional raw input payload from native node.

    • Optionalmessage?: string

      Optional node-level message from native/server.

    • OptionalpageFooter?: string

      Optional locale-resolved page footer text for ContinueNode payloads.

      Populated only for ContinueNode. Resolved by the native SDK from the stage locale map using the device's preferred locale.

    • Optionalstage?: string

      Optional raw stage JSON string for ContinueNode payloads.

      Populated only for ContinueNode.

    • OptionalsubmitButtonText?: string

      Optional locale-resolved submit button text for ContinueNode payloads.

      Populated only for ContinueNode. Resolved by the native SDK from the stage locale map using the device's preferred locale.

    • Optionaltype?: JourneyNodeType

      Terminal/non-terminal node discriminator.

    Extends shared node shape while replacing callbacks with Journey-native callback payloads.

    Settings

    Member Visibility