Configuration parameters
Discover the configuration parameters within Beefree SDK.
Passing Configurations to Beefree SDK
Once you have initialized your Beefree application, you can pass a series of configuration parameters to it.
The following code displays an example of a default configuration:
Parameters
The following table provides a description of the parameters.
Parameter | Description | Required | Default |
---|---|---|---|
uid | An alphanumeric string that identifies the user and allows the plugin to load resources for that user (e.g. images).
It uniquely identifies a user of the Plugin. When we say “uniquely”, we mean that:
| Yes | |
container | Identifies the id of div element that contains BEE Plugin | Yes | |
language | 4-letter language identifier (e.g. “en-US”, ISO 639-1 format). Available Languages | No |
|
Events and Methods
The following table provides descriptions of the events and methods:
Events and Methods | Description | Required | Default |
---|---|---|---|
trackChanges | Track message changes in the editor via the “onChange” callback. See “Tracking message changes” for further details. | No |
|
specialLinks | An array of custom links that may be used in the message (e.g. unsubscribe). See “extending the editor” for further details. | No |
|
mergeTags | An array of merge tags that may be used in the message (e.g. first name of the recipient). See “extending the editor” for further details. | No |
|
mergeContents | An array of content elements that may be used in the message (e.g. small blocks of HTML). See “extending the editor” for further details. | No |
|
preventClose | Whether an alert should be shown when the user attempts to leave the page before saving. | No |
|
editorFonts | Customize the list of available fonts in the editor’s text toolbar and the BODY settings panel. See “Font management” for further details. | No | See “Font management” for the default object. |
roleHash | Identifies the user role:
See “Roles and permissions” for further details. | No |
|
rowDisplayConditions | Allows for conditional statements in email messages. See “Display Conditions” for further details. | No |
|
workspace | Configure the initial workspace for loading the editor. Currently used for AMP content visibility. See “Workspaces” for further details. | No |
|
contentDialog | Allows to exchange data with BEE Plugin using a UI layer you control. See the “Content Dialog” page for the complete reference. | No |
|
defaultForm | This should contain a | No |
|
commenting | Enables commenting on content blocks and rows. See Commenting for further details. | No |
|
commentingThreadPreview | Enables a pop-over preview on the stage for comments. | No |
|
commentingNotifications | Enables notifications of new comments in co-editing. | No |
|
disableLinkSanitize | Disables link validation for URLs, including telephone number or SMS to enable merge content use. | No |
|
loadingSpinnerDisableOnSave | Controls the visibility of the builder in a loading state. | No |
|
loadingSpinnerDisableOnDialog | Controls the visibility of the builder in a loading state. | No |
|
Last updated