Interface EngageClient

Dispatches events that are fired.

interface EngageClient {
    addEventListener<TType extends Error>(
        type: TType | readonly TType[],
        listener: EventListener<EngageEventMap[TType]>,
    ): void;
    clearCluster(type: ClusterType): void;
    destroy(): void;
    getCluster(type: ClusterType, config?: ClusterConfig): Cluster;
    removeEventListener<TType extends Error>(
        type: TType | readonly TType[],
        listener: EventListener<EngageEventMap[TType]>,
    ): void;
    setSignInEntity(entity?: SignIn): void;
    setSubscription(
        accountProfile: AccountProfile,
        subscription?: Subscription,
    ): void;
}

Hierarchy (View Summary)

EventDispatcher<EngageEventMap>
- EngageClient

Index

Methods

addEventListener clearCluster destroy getCluster removeEventListener setSignInEntity setSubscription

Methods

addEventListener

addEventListener<TType extends Error>(
type: TType | readonly TType[],
listener: EventListener<EngageEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends Error
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<EngageEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in internal/event/EventDispatcher.ts:39

clearCluster

clearCluster(type: ClusterType): void
Clears and unpublishes a cluster by type.
Parameters
- type: ClusterType
  cluster type, either "Continuation", "Recommendation" or "Featured".
Returns void
- Defined in api/EngageClient.ts:22

destroy

destroy(): void
Release the client.

Returns void
- Defined in api/EngageClient.ts:42

getCluster

getCluster(type: ClusterType, config?: ClusterConfig): Cluster
Return a cluster by type.
Parameters
- type: ClusterType
  cluster type, either "Continuation", "Recommendation" or "Featured".
- Optionalconfig: ClusterConfig
  set the cluster configuration.
Returns Cluster
- Defined in api/EngageClient.ts:15

removeEventListener

removeEventListener<TType extends Error>(
type: TType | readonly TType[],
listener: EventListener<EngageEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends Error
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<EngageEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in internal/event/EventDispatcher.ts:47

setSignInEntity

setSignInEntity(entity?: SignIn): void
Provide a SignIn entity.
Parameters
- Optionalentity: SignIn
Returns void
- Defined in api/EngageClient.ts:27

setSubscription

setSubscription(
accountProfile: AccountProfile,
subscription?: Subscription,
): void
Set or update the subscription information whenever the user performs one of the following actions:
- Log in to your app;
- If your app supports single account with multiple profiles, user switches between profiles;
- Purchase a new subscription;
- Upgrades an existing subscription;
- Existing user subscription or tiered subscription expires.
Parameters
- accountProfile: AccountProfile
- Optionalsubscription: Subscription
Returns void
- Defined in api/EngageClient.ts:37