Configuration parameters
Discover the configuration parameters within Beefree SDK.
Passing Configurations to Beefree SDK
Once you have initialized your Beefree SDK 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 list of the required parameters.
Parameter | Description | Default |
---|---|---|
uid | An alphanumeric string that identifies the user and allows the SDK to load resources for that user (e.g. images).
It uniquely identifies a user of Beefree SDK. When we say “uniquely”, we mean that:
| |
container | Identifies the id of div element that contains Beefree SDK. |
Language Parameter
The following table provides a list of the language options for the language parameter. The language parameter is not required and has a default value of en-US
.
Available Languages
Language | 4-letter language identifier (e.g. “en-US”, ISO 639-1 format) |
---|---|
English: | en-US |
Spanish: | es-ES |
French: | fr-FR |
Italian: | it-IT |
Portuguese: | pt-BR |
Indonesian: | id-ID |
Japanese: | ja-JP |
Chinese: | zh-CN |
Traditional Chinese: | zh-HK |
German: | de-DE |
Danish: | da-DK |
Swedish: | sv-SE |
Polish: | pl-PL |
Hungarian: | hu-HU |
Russian: | ru-RU |
Korean: | ko-KR |
Dutch: | nl-NL |
Finnish: | fi-FI |
Czech: | cs-CZ |
Romanian: | ro-RO |
Norwegian (Bokmål): | nb-NO |
Slovenian: | sl-SI |
Parameters
The following table provides a list of the optional parameters and their corresponding descriptions.
Parameter | Description | Default |
---|---|---|
trackChanges | Track message changes in the editor via the “onChange” callback. See “Tracking message changes” for further details. |
|
specialLinks | An array of custom links that may be used in the message (e.g. unsubscribe). See “extending the editor” for further details. |
|
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. |
|
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. |
|
preventClose | Whether an alert should be shown when the user attempts to leave the page before saving. |
|
editorFonts | Customize the list of available fonts in the editor’s text toolbar and the BODY settings panel. See “Font management” for further details. | See “Font management” for the default object. |
roleHash | Identifies the user role:
See “Roles and permissions” for further details. |
|
rowDisplayConditions | Allows for conditional statements in email messages. See “Display Conditions” for further details. |
|
workspace | Configure the initial workspace for loading the editor. Currently used for AMP content visibility. See “Workspaces” for further details. |
|
contentDialog | Allows to exchange data with Beefree SDK using a UI layer you control. See the “Content Dialog” page for the complete reference. |
|
defaultForm | This should contain a |
|
commenting | Enables commenting on content blocks and rows. See Commenting for further details. |
|
commentingThreadPreview | Enables a pop-over preview on the stage for comments. |
|
commentingNotifications | Enables notifications of new comments in co-editing. |
|
disableLinkSanitize | Disables link validation for URLs, including telephone number or SMS to enable merge content use. |
|
loadingSpinnerDisableOnSave | Controls the visibility of the builder in a loading state. |
|
loadingSpinnerDisableOnDialog | Controls the visibility of the builder in a loading state. |
|
Last updated