CFC SDK

Appearance

@melio-eng/cfc-sdk

@melio-eng/cfc-sdk / CfcClient

Class: CfcClient ​

Defined in: client.ts:20

Constructors ​

Constructor ​

new CfcClient(config): CfcClient

Defined in: client.ts:27

Parameters ​

config ​

CfcClientConfig

Returns ​

CfcClient

Methods ​

destroy() ​

destroy(): void

Defined in: client.ts:48

Returns ​

void

getIframeElement() ​

getIframeElement(): HTMLIFrameElement | null

Defined in: client.ts:118

Returns ​

HTMLIFrameElement | null

init() ​

init(): void

Defined in: client.ts:31

Returns ​

void

navigateTo(target): void

Defined in: client.ts:86

Parameters ​

target ​

string

Returns ​

void

off() ​

off<T>(type, callback): void

Defined in: client.ts:105

Type Parameters ​

T ​

T extends "NAVIGATED_TO_TARGET" | "LOADED" | "CONTENT_SIZE_CHANGE" | "SCROLL_TO" | "EXIT_REQUESTED" | "AUTHENTICATION_ERROR" | "SESSION_EXPIRED" | "USER_ACTIVE_PING" | "SUBSCRIPTION_UPGRADE_REQUEST"

Parameters ​

type ​

T

callback ​

CfcEventCallback<CfcMessageMap[T]>

Returns ​

void

on() ​

on<T>(type, callback): () => void

Defined in: client.ts:90

Type Parameters ​

T ​

T extends "NAVIGATED_TO_TARGET" | "LOADED" | "CONTENT_SIZE_CHANGE" | "SCROLL_TO" | "EXIT_REQUESTED" | "AUTHENTICATION_ERROR" | "SESSION_EXPIRED" | "USER_ACTIVE_PING" | "SUBSCRIPTION_UPGRADE_REQUEST"

Parameters ​

type ​

T

callback ​

CfcEventCallback<CfcMessageMap[T]>

Returns ​

(): void

Returns ​

void

sendMessage() ​

sendMessage<T>(type, payload): void

Defined in: client.ts:68

Type Parameters ​

T ​

T extends "NAVIGATE_REQUEST" | "USER_SCROLL" | "DIMENSIONS_CHANGED" | "SUBSCRIPTION_UPGRADE_FINISHED"

Parameters ​

type ​

T

payload ​

Omit<Extract<HostMessage, { type: T; }>, "type" | "messageId">

Returns ​

void

sendSubscriptionUpgradeFinished() ​

sendSubscriptionUpgradeFinished(wasUpgraded): void

Defined in: client.ts:122

Parameters ​

wasUpgraded ​

boolean

Returns ​

void