chat

The chat layer creates a chat view.

Field Configurations

Key	Type	Description	Default Value
"chatType"	ChatType	Type of this chat.	"default"
"dateForeground"	Color	Color of the displayed date.	"Depends on system."
"displayImages"	Boolean	Flag if displaying images is possible.	true
"font"	String	The font for the messages.	"Depends on system."
"fontSize"	UnitSize	The font size of the messages	"Depends on system."
"imageAdditionalHeaders"	AdditionalHeaders	Http headers for a http request.	null
"imageBaseUrl"	String	The base URL for images.	null
"imageCruncher"	ImageCruncher	ImageCruncher config to apply to images.	null
"initialMessage"	String	(Android only) Message to display in the textfield used to type messages. Can be edited by the user.	null
"inputBackground"	Color	The background color of the text input view.	"Depends on system."
"inputForeground"	Color	The foreground color of the text input view.	"Depends on system."
"linkProcessType"	LinkProcessType	Indicates how links in messages should be handled.	"none"
"messageComparisonMode"	MessageComparisonMode	How the chat layer compares its messages to send with the actual messages of the chat.	"byContent"
"messageMode"	MessageMode	Chat message mode.	"plain"
"myBackground"	Color	The background color of my chat bubbles.	"Depends on system."
"myForeground"	Color	The font color of my chat bubbles.	"Depends on system."
"nameForeground"	Color	The font color of the name which is displayed.	"Depends on system."
"namedMessageActions"	Object	Actions a message can have on long press.	null
"otherBackground"	Color	The background color of the chat partners bubbles.	"Depends on system."
"otherForeground"	Color	The font color of the chat partners bubbles.	"Depends on system."
"query"	String	The query of the table defined in table to use.	null
"queryParams"	Array	Query parameters to use for the query defined in query.	null
"retryBodyText"	String	The body text of the retry.	null
"retryConfirmationText"	String	The confirmation text of the retry.	null
"retryDeclineText"	String	The decline text of the retry.	null
"retryTitleText"	String	The title of the retry.	null
"sendBackground"	Color	The background color of the send button.	"Depends on system."
"sendDisabledMessage"	String	Message shown in the send bar if send is disabled.	null
"sendDisabledMessageBackgroundColor"	Color	Background color of the disabled send message.	"Depends on system."
"sendDisabledMessageFont"	String	Font of the disabled send message.	"Depends on system."
"sendDisabledMessageFontColor"	Color	Font color of the disabled send message.	"Depends on system."
"sendDisabledMessageFontSize"	UnitSize	Font size of the disabled send message.	"Depends on system."
"sendEnabled"	Boolean	Indicates if the send button in enabled.	true
"sendForeground"	Color	The font color of the send button.	"Depends on system."
"submitActions"	ActionList	Actions fired after submitted.	null
"systemMessage"	String	Text of the system message	null
"systemMessageBackground"	Color	Background color for system messages.	"Depends on system."
"systemMessageForeground"	Color	Font color for system messages.	"Depends on system."
"table"	String	Database table to use.	null
"uploadDesiredHeight"	Number		null
"uploadDesiredWidth"	Number		null
"uploadEvent"	String	Event to fire when media was picked.	null
"uploadForm"	String	The form to use for file uploads.	null
"uploadMaxDimension"	Number	undefined	null
"uploadMode"	UploadMode	Indicates what kind of media can be uploaded.	"none"
"uploadTypes"	UploadTypes	List of upload modes, excluding none. Overrides uploadMode.	null
"valueMap"	Object	The value map to apply.	null

Inherited

From Base Layer

Base Layer

Field Configurations

Key	Type	Description	Default Value
"_value"	Value	[PREVIEW] Dynamic value of the layer.	null
"accessibilityAppendState"	String	Defines this layer appends its state to the accessibility text.	null
"accessibilityText"	String	Text for accessibility navigation. Can be translated.	null
"actions"	ActionList	List of actions, which will be executed when the layer is tapped.	null
"borderColor"	Color	The color of the border in hex color value.	null
"borderRadius"	UnitSize	The radius applies to all corners; with a borderWidth of 0 the border is not drawn and radius is set anyway.	0
"borderWidth"	UnitSize	The width of the border.	0
"bottomLeftRadius"	UnitSize	Radius for the bottom left corner.	0
"bottomRightRadius"	UnitSize	Radius for the bottom right corner.	0
"classes"	Array	List of classes for layer styles.	null
"conditions"	Conditions	List of conditions to alter the layer state.	null
"constraints"	Constraints	A list of constraints defining the position of the layer in a layout.	null
"consumesKeyboard"	Boolean	This layer will be used to shrink, if a keyboard is shown.	null
"dataKey"	String	Name for assigning data to this layer.	null
"focusColor"	Color	The highlight color of this layer when it is focused. Mainly used on TV. If no color is provided, the pressedColor will be used.	null
"hidden"	Boolean	Indicates whether the layer is hidden. Default: false.	false
"isAccessibilityElement"	String	Defines if this layer is important for accessibility navigation. The default depends on the layer type.	null
"layerRotation"	Number	The layer is rotated by the specified degree.	0
"name"	String	Unique name in the layout. Used for alignment or actions.	null
"opacity"	Number	The opacity of the layer.	1
"overInsetBottom"	Boolean	Determines if this layer ignores the save space at the bottom of the device.	false
"overInsetTop"	Boolean	Determines if this layer ignores the save space at the top of the device.	false
"pressedColor"	Color	The highlight color of this layer when it is pressed. Mainly used on TV. If no color is provided, the focusColor will be used.	null
"safeArea"	SafeAreaTypeObject	Determines the safe area behaviour.	null
"shadowElevation"	Number	The elevation of this layer for casting shadows.	0
"state"	String	The state the layer will use as default.	"default"
"states"	LayerStates	A list of named states that affect the appearance of the layer.	null
"topLeftRadius"	UnitSize	Radius for the top left corner.	0
"topRightRadius"	UnitSize	Radius for the top right corner.	0
"touchFeedback"	TouchFeedback	Determines if the layer should show a touch feedback if touched.	"visible"
"trackingKey"	String	Defines a key for a scroll event.	null
"type"	LayerType	The type of the layer	null
"value"	Value	(Initial) value of the layer.	null

Examples

Example 1: Create a chat

To achieve this the following code can be used:

{
  "type": "chat",
  "name": "chat",
  "table": "chat",
  "query": "default",
  "otherBackground": "#F3F3F3",
  "otherForeground": "#202424",
  "myBackground": "#96CAD9",
  "myForeground": "#202424",
  "inputBackground": "#F3F3F3",
  "sendBackground": "#2F96B4",
  "sendForeground": "#FFFFFF",
  "nameForeground": "#2F96B4",
  "font": "",
  "valueMap": {
    "message": "text",
    "timeStamp": "timestamp",
    "counterpart": "counterpart",
    "type": "type",
    "actions": "actions",
    "mediaType": "mediaType"
  },
  "chatType": "group",
  "displayImage": true,
  "messageMode": "markdown",
  "uploadTypes": [
    "image",
    "pdf"
  ],
  "uploadEvent": "uploadChatFile",
  "uploadForm": "chatForm",
  "submitActions": [
    {
      "type": "request",
      "params": {
        "url": "randomUrl",
        "method": "POST",
        "contentType": "json",
        "post": {
          "content": "{[message]}"
        },
        "onSuccess": "messageSent",
        "onError": "messageError"
      }
    }
  ],
  "namedMessageActions": {
    "delete": {
      "label": "$lang(chatActionDelete)$",
      "image": "internal://remove",
      "event": "deleteMessage"
    },
    "change": {
      "label": "$lang(chatActionChange)$",
      "image": "internal://settings",
      "event": "changeMessage"
    },
    "copy": {
      "label": "$lang(chatActionCopy)$",
      "image": "internal://copy",
      "event": "copyMessage"
    }
  },
  "classes": [
    "fontSizeM",
    "fullSize"
  ]
}

The example shows a chat layer with typical known chat functions.

Result:

A chat layer has been created.