Contents
API Commands
configure
Configure the widget.
Options
| Option | Type | Description |
|---|---|---|
| apikey | string | Apigee Proxy secure token |
| dataURL | URL String | URL of GMS server |
| ajaxTimeout | number | Number of milliseconds to wait before AJAX timeout |
| userData | object | Arbitrary JSON data to attach to the message. |
Resolutions
| Status | When | Returns |
|---|---|---|
| resolved | When configuration options are provided and set | n/a |
| rejected | When no configuration options are provided | 'Invalid configuration' |
sendForm
Sends a Message with the Email server via GMS. Intended to be used by Send Message widgets only. Should not be invoked manually.
Options
| Option | Type | Description |
|---|---|---|
| firstName | string | Send Message Entry Form Data: 'First Name'. |
| lastName | string | Send Message Entry Form Data: 'Last Name'. |
| string | Send Message Entry Form Data: 'Email'. | |
| subject | string | Send Message Entry Form Data: 'Subject'. |
| text | string | Send Message Entry Form Data for message body content. |
| files | array | Array of file objects containing the attached files.Intended to be used by Send Message widgets only. |
| userData | object | Arbitrary data to attach to the message (AKA attachedData). Properties defined here will be merged with default userData set in the configuration object. |
Resolutions
| Status | When | Returns |
|---|---|---|
| resolved | When server confirms message sent | (AJAX Response Object) |
| rejected | When a browser does not support HTML5 form attachments | 'No HTMl5 formData support on your browser' |
| rejected | When no form data passed | 'No formData found' |
Comments or questions about this documentation? Contact us for support!
