Class CfgnClient

Hierarchy

CfgnClient

Index

Constructors

constructor

Methods

Constructors

constructor

new CfgnClient(): CfgnClient

Returns CfgnClient

Methods

Static changeCfgnValue

changeCfgnValue(values: CfgnValue | CfgnValue[], callback?: Function, defer?: boolean): void

- Defined in typings/cbn/cfgn-client.d.ts:22
Parameters
- values: CfgnValue | CfgnValue[]
- Optional callback: Function
- Optional defer: boolean
Returns void

Static checkout

checkout(shopInput?: string, callback?: Function, errorCallback?: Function): void

- Defined in typings/cbn/cfgn-client.d.ts:3
Parameters
- Optional shopInput: string
- Optional callback: Function
- Optional errorCallback: Function
Returns void

Static generateCustomId

generateCustomId(callback: (customId: string) => void, errorCallback?: Function): void

- Defined in typings/cbn/cfgn-client.d.ts:37
Generates a custom ID for the current configuration.
Can be used in configurator previews as well, but always returns the same custom ID there.

Note

Before this can be used, custom IDs need to be activated once for the configurator.
Activation is done via Cbn.ApiClient.setupCustomId or Cbn.ApiClient.setupShuffledCustomId.

Parameters
- callback: (customId: string) => void
  - - (customId: string): void
    - Parameters
      - customId: string
      Returns void
- Optional errorCallback: Function
Returns void

Static sendMail

sendMail(subject: string, body: string, from: MailAddress, to: MailAddress[], cc: MailAddress[], bcc: MailAddress[], attachments?: MailAttachments[], callback?: Function, errorCallback?: Function): void

- Defined in typings/cbn/cfgn-client.d.ts:5
Parameters
- subject: string
- body: string
- from: MailAddress
- to: MailAddress[]
- cc: MailAddress[]
- bcc: MailAddress[]
- Optional attachments: MailAttachments[]
- Optional callback: Function
- Optional errorCallback: Function
Returns void

Generated using TypeDoc