Type Alias JourneyApi

Client-only API for consent, publication, observation, and retirement of transient Journey state.

type JourneyApi = {
    disable(): Promise<SporadesResult<{ ok: boolean }>>;
    enable(
        options?: JourneyEnableOptions,
    ): Promise<SporadesResult<JourneyEnableResult>>;
    list(): Promise<SporadesResult<{ journeys: JourneyRecord[] }>>;
    set(
        state: JourneySetInput,
    ): Promise<SporadesResult<{ journey: JourneyRecord }>>;
    subscribe(listener: (event: JourneyEvent) => void): JourneySubscription;
}

Index

Methods

disable enable list set subscribe

Methods

disable

disable(): Promise<SporadesResult<{ ok: boolean }>>
Returns Promise<SporadesResult<{ ok: boolean }>>
- Defined in client.d.ts:43

enable

enable(
options?: JourneyEnableOptions,
): Promise<SporadesResult<JourneyEnableResult>>
Parameters
- Optionaloptions: JourneyEnableOptions
Returns Promise<SporadesResult<JourneyEnableResult>>
- Defined in client.d.ts:39

list

list(): Promise<SporadesResult<{ journeys: JourneyRecord[] }>>
Returns Promise<SporadesResult<{ journeys: JourneyRecord[] }>>
- Defined in client.d.ts:41

set

set(state: JourneySetInput): Promise<SporadesResult<{ journey: JourneyRecord }>>
Parameters
- state: JourneySetInput
Returns Promise<SporadesResult<{ journey: JourneyRecord }>>
- Defined in client.d.ts:40

subscribe(listener: (event: JourneyEvent) => void): JourneySubscription
Parameters
- listener: (event: JourneyEvent) => void
Returns JourneySubscription
- Defined in client.d.ts:42