CFC SDK

Appearance

@melio-eng/cfc-sdk

@melio-eng/cfc-sdk / CfcClientConfig

Interface: CfcClientConfig ​

Defined in: types.ts:137

Properties ​

allowedOrigin? ​

optional allowedOrigin: string

Defined in: types.ts:145

container ​

container: HTMLElement

Defined in: types.ts:138

environment ​

environment: Environment

Defined in: types.ts:139

headerHeight? ​

optional headerHeight: number

Defined in: types.ts:144

isMobileApp? ​

optional isMobileApp: boolean

Defined in: types.ts:166

mode ​

mode: IntegrationMode

Defined in: types.ts:143

onAuthenticationError()? ​

optional onAuthenticationError: (reason, message) => void

Defined in: types.ts:155

Parameters ​

reason ​

AuthErrorReason

message ​

string

Returns ​

void

onDownloadFile()? ​

optional onDownloadFile: (fileName, data) => void

Defined in: types.ts:167

Parameters ​

fileName ​

string

data ​

string

Returns ​

void

onError()? ​

optional onError: (error) => void

Defined in: types.ts:171

Parameters ​

error ​

Error

Returns ​

void

onExitRequested()? ​

optional onExitRequested: (originator) => void

Defined in: types.ts:157

Parameters ​

originator ​

string

Returns ​

void

onLoaded()? ​

optional onLoaded: () => void

Defined in: types.ts:148

Returns ​

void

onMessage()? ​

optional onMessage: (message) => void

Defined in: types.ts:170

Parameters ​

message ​

CfcMessage

Returns ​

void

onNavigated()? ​

optional onNavigated: (target, targetAction?) => void

Defined in: types.ts:151

Parameters ​

target ​

string

targetAction? ​

string

Returns ​

void

onPaymentSuccess()? ​

optional onPaymentSuccess: () => void

Defined in: types.ts:152

Returns ​

void

onSessionExpired()? ​

optional onSessionExpired: () => void

Defined in: types.ts:156

Returns ​

void

onUpgradeRequest()? ​

optional onUpgradeRequest: (featureName, returnUrl) => void

Defined in: types.ts:160

Parameters ​

featureName ​

string

returnUrl ​

string

Returns ​

void

onUserActivePing()? ​

optional onUserActivePing: () => void

Defined in: types.ts:163

Returns ​

void

target? ​

optional target: string

Defined in: types.ts:142

tenant ​

tenant: string

Defined in: types.ts:141

token ​

token: string

Defined in: types.ts:140