Class CfgnClient

Hierarchy

CfgnClient

Index

Constructors

Methods

changeCfgnValue checkout onBeforeCheckout sendMail startSpecificationResourceUpload

Constructors

constructor

new CfgnClient(): CfgnClient
Returns CfgnClient

Methods

`Static` changeCfgnValue

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

`Static` checkout

checkout(input: CheckoutInput, callback?: Function, errorCallback?: Function): void
Parameters
- input: CheckoutInput
- Optional callback: Function
- Optional errorCallback: Function
Returns void

`Static` onBeforeCheckout

onBeforeCheckout(listener: OnBeforeCheckoutListener): void
Parameters
- listener: OnBeforeCheckoutListener
Returns void

`Static` sendMail

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

`Static` startSpecificationResourceUpload

startSpecificationResourceUpload(cmpName: string, resourceName: string, fileExtension: string, callback?: Function, errorCallback?: Function): void
Request SAS URI to upload a specification resources (end user resources...)
Parameters
- cmpName: string
- resourceName: string
- fileExtension: string
- Optional callback: Function
  
  Called after the server returned with an authenticate message
- Optional errorCallback: Function
Returns void

Generated using TypeDoc