Chat

Displays a chat or conversation history.

Appearance

Chat.png

SQL

SQL Call: Init (mandatory)

May modify database: No

Parameters

@Action string
Set to 'Init' for this call.

Resultset: Settings (optional)

Table count: repeated zero or one time
Row count: exactly one row
Columns
IsReadOnly optional bit

Set to 1 if the chat is in read only mode. This hides the textbox used to send messages.

Default: 0.
ShowAiWarning optional bit

Set to 1 if a warning that AI messages could be wrong should be displayed below the text input.

Default: 0.
SyncId optional string

The id to listen for sync events on. Required when the component uses collaborative editing.

SyncTimestamp optional string

Arbitrary value to keep track of the latest client sync moment. This value is sent as the @SyncTimestamp parameter in the 'Client sync' call and should be used to determine what changed since the last sync moment. Required when the component uses collaborative editing.

SQL Call: Get chat data (mandatory)

This call is made when first loading the chat and when loading the chat history.

May modify database: No

Parameters

@Action string
Set to 'GetChatData' for this call.

Resultset: Participants

Chat participants.

Table count: repeated exactly once
Row count: zero or more rows
Columns
AvatarColor optional any

The color of the participant's avatar.

Default: Gray.
DisplayName mandatory string

Name to show under the participant's messages.

IsAi optional bit

Set to 1 if the message is from an AI model.

Default: 0.
IsSelf optional bit

Set to 1 if the participant is the user currently viewing the chat.

Default: 0.
ParticipantId mandatory string

Id of the participant.

Resultset: Messages

All messages to display in the chat in order from oldest to newest.

Table count: repeated exactly once
Row count: zero or more rows
Columns
<xxx> optional string

Additional columns can be added in the result set, these can be used for passingfields, depends on in chat message links.

CanDelete optional bit

Set to 1 if the message can be deleted.

Default: 0.
CanEdit optional bit

Set to 1 if the message can be edited.

Default: 0.
EditDatetimeUtc optional datetime

The datetime the message was last edited.

IsSystemMessage optional bit

Set to 1 if the message should be displayed as a system message.

Default: 0.
Message optional string

Plaintext message. Mutually exclusive with MessageMarkdown.

MessageId mandatory int

Unique message id. Must be in a strictly ascending order. Will be used in the Store message and Delete message calls.

MessageMarkdown optional string

Message containing markdown. Mutually exclusive with Message.

ParticipantId optional string

An id corresponding to a participant in the Participants table. Mandatory if 'IsSystemMessage' is 0.

SentDatetimeUtc optional datetime

The datetime of when the message was sent. Mandatory if the column is present.

SQL Call: Store message

Called when the user tries to send a message.

May modify database: Yes

Parameters

@Action string
Set to 'StoreMessage' for this call.
@Message string
The content of the message.

Resultset: Messages (optional)

If any messages are returned a partial update of the chat is performed.

Note that partial updates can't be used together with any confirmation message. After the user has clicked OK the whole chat is always reloaded.

Table count: repeated zero or one time
Row count: zero or more rows
Columns
<xxx> optional string

Additional columns can be added in the result set, these can be used for passingfields, depends on in chat message links.

CanDelete optional bit

Set to 1 if the message can be deleted.

Default: 0.
CanEdit optional bit

Set to 1 if the message can be edited.

Default: 0.
EditDatetimeUtc optional datetime

The datetime the message was last edited.

IsSystemMessage optional bit

Set to 1 if the message should be displayed as a system message.

Default: 0.
Message optional string

Plaintext message. Mutually exclusive with MessageMarkdown.

MessageId mandatory int

Unique message id. Must be in a strictly ascending order. Will be used in the Store message and Delete message calls.

MessageMarkdown optional string

Message containing markdown. Mutually exclusive with Message.

ParticipantId optional string

An id corresponding to a participant in the Participants table. Mandatory if 'IsSystemMessage' is 0.

RemoveMessage optional bit

If set to 1 the message will be removed from the user interface if present.

Default: 0.
SentDatetimeUtc optional datetime

The datetime of when the message was sent. Mandatory if the column is present.

Resultset: Reload (optional)

Can be used when partial updates are not sufficient.

Can not be combined with the 'Messages' result set.

Table count: repeated zero or one time
Row count: exactly one row
Columns
Reload mandatory bit

Set to 1 to trigger a 'Get chat data' call.

Resultset: Forwarding Definitions (optional)

Table count: repeated zero or one time
Row count: exactly one row
Columns
ADMIN_ErrorMessage optional string

Displays a user friendly error message to the user. This blocks any forwarding for the user.

ADMIN_ConfirmDelete optional string

Displays a user friendly confirmation message to the user with a delete button as the confirm button. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Delete'.

ADMIN_ConfirmQuestion optional string

Displays a user friendly confirmation message to the user with a question style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_ConfirmWarning optional string

Displays a user friendly confirmation message to the user with a warning style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_InfoMessage optional string

Displays a user friendly info message to the user. When the user clicks OK the user is forwarded.

ADMIN_SuccessMessage optional string

Displays a user friendly success message to the user. When the user clicks OK the user is forwarded.

ADMIN_Dialog optional string

The dialog alias of a predefined dialog to show the user. Must be the first column in the result set table. Use multiple result set tables to combine with other forwarding.

Use the menu item "Admin > Dialogs" to register new dialogs or find aliases for existing ones.

<xxx> (for ADMIN_Dialog) optional any

Any column without special meaning in the result set with the first column ADMIN_Dialog will be used to make replacements of placeholders in the message and title text.

ADMIN_DebugInfo optional string

Additional information to show the developer when using ADMIN_Dialog.

<passing_field> optional string
Any column with no other specific meaning will pe passed along to the menu item you are forwarding to.
ADMIN_CancelCidStepsBack optional int
Number of steps in the page history to jump back if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelcidstepsback specified in the query string.
ADMIN_CancelReturnToMenuItem optional string
Jumps back to the menu item with this alias if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). If no prior menu item is found with the given alias, then an error is thrown.
ADMIN_CancelMenuItem optional string
Alias of the menu item to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.
ADMIN_CidStepsBack optional int
Number of steps in the page history to jump back after execution (the default being one step back). This value overrides any destination specified by the query string.
ADMIN_ReturnToMenuItem optional string
Jumps back to the menu item with this alias after execution. This value overrides any destination specified by the query string. If no prior menu item is found with the given alias, then an error is thrown.
ADMIN_Force optional string
Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.
ADMIN_Forward optional string
Displays a user friendly message and then forwards to the next menu item.
ADMIN_ForwardLink optional string
Alias of the link to forward to.
ADMIN_ForwardMenuGroup optional string

Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItem optional string
Alias of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.
ADMIN_Message optional string

Displays a user friendly error message to the user.

ADMIN_PasteHtmlFromPopup optional string
Pastes HTML into an HTML editor. See ADMIN_SetFieldValueFromPopup.
ADMIN_SetFieldValueFromPopup optional string
Sets the value of the field specified in the menuitempopup call. Only select this column if menu item is opened in a popup.
ADMIN_ClosePopup optional bit
If this column is anything but NULL the popup will be closed. Only select this column if the menu item is opened in a popup.
Default: The default behavior is to step back inside the popup window and close it if there is nothing to step back to.
ADMIN_ClosePopupAndReloadOpener optional bit

If this column is anything but NULL the popup will be closed and the parent will be reloaded. Only select this column if the menu item is opened in a popup. Avoid using this feature if the opener is a newEdit as that may interrupt the user's ongoing input.

ADMIN_ClearHistory optional any
When the value is not NULL all navigation history is cleared and the user can't navigate back. This is only supported when forwarding to another menu item.
ADMIN_Force optional string

Confirmation message to show.

ADMIN_Message optional string

Message to show (preventing the action).

ADMIN_RefreshMenu optional bit
Will trigger a reload of the sidebar if the column is anything but NULL.
Cache optional string
Cache key to be cleared. Supports wildcards.
CacheUserId optional string
Either a user id or '%'.

Clears all caches (e.g. access permissions) related to the specified user id.

Use '%' to clear caches for all users.
CancelButtonText optional string

Changes the text of the Cancel button when used with ADMIN_Force, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete.

OkButtonText optional string

Changes the text of the OK button when used with ADMIN_ErrorMessage, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete, ADMIN_InfoMessage, ADMIN_SuccessMessage, ADMIN_Message, ADMIN_Force, or ADMIN_Forward. ADMIN_Force,

Resultset: Raise sync entity (optional)

This SQL call may use SoftadminApi.SyncEntity_RaiseChanged.

Table count: repeated zero or more times
Row count:
Columns

SQL Call: Edit message

Called when the user tries to save an edited message.

May modify database: Yes

Parameters

@Action string
Set to 'EditMessage' for this call.
@Message string
The content of the message.
@MessageId int
The Id of the message that was edited.

Resultset: Messages (optional)

If any messages are returned a partial update of the chat is performed.

Note that partial updates can't be used together with any confirmation message. After the user has clicked OK the whole chat is always reloaded.

Table count: repeated zero or one time
Row count: zero or more rows
Columns
<xxx> optional string

Additional columns can be added in the result set, these can be used for passingfields, depends on in chat message links.

CanDelete optional bit

Set to 1 if the message can be deleted.

Default: 0.
CanEdit optional bit

Set to 1 if the message can be edited.

Default: 0.
EditDatetimeUtc optional datetime

The datetime the message was last edited.

IsSystemMessage optional bit

Set to 1 if the message should be displayed as a system message.

Default: 0.
Message optional string

Plaintext message. Mutually exclusive with MessageMarkdown.

MessageId mandatory int

Unique message id. Must be in a strictly ascending order. Will be used in the Store message and Delete message calls.

MessageMarkdown optional string

Message containing markdown. Mutually exclusive with Message.

ParticipantId optional string

An id corresponding to a participant in the Participants table. Mandatory if 'IsSystemMessage' is 0.

RemoveMessage optional bit

If set to 1 the message will be removed from the user interface if present.

Default: 0.
SentDatetimeUtc optional datetime

The datetime of when the message was sent. Mandatory if the column is present.

Resultset: Reload (optional)

Can be used when partial updates are not sufficient.

Can not be combined with the 'Messages' result set.

Table count: repeated zero or one time
Row count: exactly one row
Columns
Reload mandatory bit

Set to 1 to trigger a 'Get chat data' call.

Resultset: Forwarding Definitions (optional)

Table count: repeated zero or one time
Row count: exactly one row
Columns
ADMIN_ErrorMessage optional string

Displays a user friendly error message to the user. This blocks any forwarding for the user.

ADMIN_ConfirmDelete optional string

Displays a user friendly confirmation message to the user with a delete button as the confirm button. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Delete'.

ADMIN_ConfirmQuestion optional string

Displays a user friendly confirmation message to the user with a question style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_ConfirmWarning optional string

Displays a user friendly confirmation message to the user with a warning style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_InfoMessage optional string

Displays a user friendly info message to the user. When the user clicks OK the user is forwarded.

ADMIN_SuccessMessage optional string

Displays a user friendly success message to the user. When the user clicks OK the user is forwarded.

ADMIN_Dialog optional string

The dialog alias of a predefined dialog to show the user. Must be the first column in the result set table. Use multiple result set tables to combine with other forwarding.

Use the menu item "Admin > Dialogs" to register new dialogs or find aliases for existing ones.

<xxx> (for ADMIN_Dialog) optional any

Any column without special meaning in the result set with the first column ADMIN_Dialog will be used to make replacements of placeholders in the message and title text.

ADMIN_DebugInfo optional string

Additional information to show the developer when using ADMIN_Dialog.

<passing_field> optional string
Any column with no other specific meaning will pe passed along to the menu item you are forwarding to.
ADMIN_CancelCidStepsBack optional int
Number of steps in the page history to jump back if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelcidstepsback specified in the query string.
ADMIN_CancelReturnToMenuItem optional string
Jumps back to the menu item with this alias if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). If no prior menu item is found with the given alias, then an error is thrown.
ADMIN_CancelMenuItem optional string
Alias of the menu item to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.
ADMIN_CidStepsBack optional int
Number of steps in the page history to jump back after execution (the default being one step back). This value overrides any destination specified by the query string.
ADMIN_ReturnToMenuItem optional string
Jumps back to the menu item with this alias after execution. This value overrides any destination specified by the query string. If no prior menu item is found with the given alias, then an error is thrown.
ADMIN_Force optional string
Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.
ADMIN_Forward optional string
Displays a user friendly message and then forwards to the next menu item.
ADMIN_ForwardLink optional string
Alias of the link to forward to.
ADMIN_ForwardMenuGroup optional string

Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItem optional string
Alias of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.
ADMIN_Message optional string

Displays a user friendly error message to the user.

ADMIN_PasteHtmlFromPopup optional string
Pastes HTML into an HTML editor. See ADMIN_SetFieldValueFromPopup.
ADMIN_SetFieldValueFromPopup optional string
Sets the value of the field specified in the menuitempopup call. Only select this column if menu item is opened in a popup.
ADMIN_ClosePopup optional bit
If this column is anything but NULL the popup will be closed. Only select this column if the menu item is opened in a popup.
Default: The default behavior is to step back inside the popup window and close it if there is nothing to step back to.
ADMIN_ClosePopupAndReloadOpener optional bit

If this column is anything but NULL the popup will be closed and the parent will be reloaded. Only select this column if the menu item is opened in a popup. Avoid using this feature if the opener is a newEdit as that may interrupt the user's ongoing input.

ADMIN_ClearHistory optional any
When the value is not NULL all navigation history is cleared and the user can't navigate back. This is only supported when forwarding to another menu item.
ADMIN_RefreshMenu optional bit
Will trigger a reload of the sidebar if the column is anything but NULL.
Cache optional string
Cache key to be cleared. Supports wildcards.
CacheUserId optional string
Either a user id or '%'.

Clears all caches (e.g. access permissions) related to the specified user id.

Use '%' to clear caches for all users.
CancelButtonText optional string

Changes the text of the Cancel button when used with ADMIN_Force, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete.

OkButtonText optional string

Changes the text of the OK button when used with ADMIN_ErrorMessage, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete, ADMIN_InfoMessage, ADMIN_SuccessMessage, ADMIN_Message, ADMIN_Force, or ADMIN_Forward. ADMIN_Force,

Resultset: Raise sync entity (optional)

This SQL call may use SoftadminApi.SyncEntity_RaiseChanged.

Table count: repeated zero or more times
Row count:
Columns

SQL Call: Delete message

May modify database: Yes

Parameters

@Action bit
Set to 'DeleteMessage' for this call.
@MessageId string
Id of the message to delete.

Resultset: Messages (optional)

If any messages are returned a partial update of the chat is performed.

Note that partial updates can't be used together with any confirmation message. After the user has clicked OK the whole chat is always reloaded.

Table count: repeated zero or one time
Row count: zero or more rows
Columns
<xxx> optional string

Additional columns can be added in the result set, these can be used for passingfields, depends on in chat message links.

CanDelete optional bit

Set to 1 if the message can be deleted.

Default: 0.
CanEdit optional bit

Set to 1 if the message can be edited.

Default: 0.
EditDatetimeUtc optional datetime

The datetime the message was last edited.

IsSystemMessage optional bit

Set to 1 if the message should be displayed as a system message.

Default: 0.
Message optional string

Plaintext message. Mutually exclusive with MessageMarkdown.

MessageId mandatory int

Unique message id. Must be in a strictly ascending order. Will be used in the Store message and Delete message calls.

MessageMarkdown optional string

Message containing markdown. Mutually exclusive with Message.

ParticipantId optional string

An id corresponding to a participant in the Participants table. Mandatory if 'IsSystemMessage' is 0.

RemoveMessage optional bit

If set to 1 the message will be removed from the user interface if present.

Default: 0.
SentDatetimeUtc optional datetime

The datetime of when the message was sent. Mandatory if the column is present.

Resultset: Reload (optional)

Can be used when partial updates are not sufficient.

Can not be combined with the 'Messages' result set.

Table count: repeated zero or one time
Row count: exactly one row
Columns
Reload mandatory bit

Set to 1 to trigger a 'Get chat data' call.

Resultset: Forwarding Definitions (optional)

Table count: repeated zero or one time
Row count: exactly one row
Columns
ADMIN_ErrorMessage optional string

Displays a user friendly error message to the user. This blocks any forwarding for the user.

ADMIN_ConfirmDelete optional string

Displays a user friendly confirmation message to the user with a delete button as the confirm button. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Delete'.

ADMIN_ConfirmQuestion optional string

Displays a user friendly confirmation message to the user with a question style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_ConfirmWarning optional string

Displays a user friendly confirmation message to the user with a warning style. If the user chooses OK the SQL call will be rerun with the parameter @ButtonAction set to 'Confirm'.

ADMIN_InfoMessage optional string

Displays a user friendly info message to the user. When the user clicks OK the user is forwarded.

ADMIN_SuccessMessage optional string

Displays a user friendly success message to the user. When the user clicks OK the user is forwarded.

ADMIN_Dialog optional string

The dialog alias of a predefined dialog to show the user. Must be the first column in the result set table. Use multiple result set tables to combine with other forwarding.

Use the menu item "Admin > Dialogs" to register new dialogs or find aliases for existing ones.

<xxx> (for ADMIN_Dialog) optional any

Any column without special meaning in the result set with the first column ADMIN_Dialog will be used to make replacements of placeholders in the message and title text.

ADMIN_DebugInfo optional string

Additional information to show the developer when using ADMIN_Dialog.

<passing_field> optional string
Any column with no other specific meaning will pe passed along to the menu item you are forwarding to.
ADMIN_CancelCidStepsBack optional int
Number of steps in the page history to jump back if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelcidstepsback specified in the query string.
ADMIN_CancelReturnToMenuItem optional string
Jumps back to the menu item with this alias if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). If no prior menu item is found with the given alias, then an error is thrown.
ADMIN_CancelMenuItem optional string
Alias of the menu item to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.
ADMIN_CidStepsBack optional int
Number of steps in the page history to jump back after execution (the default being one step back). This value overrides any destination specified by the query string.
ADMIN_ReturnToMenuItem optional string
Jumps back to the menu item with this alias after execution. This value overrides any destination specified by the query string. If no prior menu item is found with the given alias, then an error is thrown.
ADMIN_Force optional string
Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.
ADMIN_Forward optional string
Displays a user friendly message and then forwards to the next menu item.
ADMIN_ForwardLink optional string
Alias of the link to forward to.
ADMIN_ForwardMenuGroup optional string

Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItem optional string
Alias of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.
ADMIN_Message optional string

Displays a user friendly error message to the user.

ADMIN_PasteHtmlFromPopup optional string
Pastes HTML into an HTML editor. See ADMIN_SetFieldValueFromPopup.
ADMIN_SetFieldValueFromPopup optional string
Sets the value of the field specified in the menuitempopup call. Only select this column if menu item is opened in a popup.
ADMIN_ClosePopup optional bit
If this column is anything but NULL the popup will be closed. Only select this column if the menu item is opened in a popup.
Default: The default behavior is to step back inside the popup window and close it if there is nothing to step back to.
ADMIN_ClosePopupAndReloadOpener optional bit

If this column is anything but NULL the popup will be closed and the parent will be reloaded. Only select this column if the menu item is opened in a popup. Avoid using this feature if the opener is a newEdit as that may interrupt the user's ongoing input.

ADMIN_ClearHistory optional any
When the value is not NULL all navigation history is cleared and the user can't navigate back. This is only supported when forwarding to another menu item.
ADMIN_Force optional string

Confirmation message to show.

ADMIN_Message optional string

Message to show (preventing the action).

ADMIN_RefreshMenu optional bit
Will trigger a reload of the sidebar if the column is anything but NULL.
Cache optional string
Cache key to be cleared. Supports wildcards.
CacheUserId optional string
Either a user id or '%'.

Clears all caches (e.g. access permissions) related to the specified user id.

Use '%' to clear caches for all users.
CancelButtonText optional string

Changes the text of the Cancel button when used with ADMIN_Force, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete.

OkButtonText optional string

Changes the text of the OK button when used with ADMIN_ErrorMessage, ADMIN_ConfirmWarning, ADMIN_ConfirmQuestion, ADMIN_ConfirmDelete, ADMIN_InfoMessage, ADMIN_SuccessMessage, ADMIN_Message, ADMIN_Force, or ADMIN_Forward. ADMIN_Force,

Resultset: Raise sync entity (optional)

This SQL call may use SoftadminApi.SyncEntity_RaiseChanged.

Table count: repeated zero or more times
Row count:
Columns

SQL Call: Client sync

Called when a sync entity change is raised for the entity and id that the component listens to.

May modify database: No

Parameters

@Action string
Set to 'ClientSync' for this call.
@SyncId string
The sync id that was retrieved from the initial SQL call.
@SyncTimestamp string
The sync timestamp from when the component was last synced.

Resultset: Messages (optional)

If any messages are returned a partial update of the chat is performed.

Table count: repeated zero or one time
Row count: zero or more rows
Columns
<xxx> optional string

Additional columns can be added in the result set, these can be used for passingfields, depends on in chat message links.

CanDelete optional bit

Set to 1 if the message can be deleted.

Default: 0.
CanEdit optional bit

Set to 1 if the message can be edited.

Default: 0.
EditDatetimeUtc optional datetime

The datetime the message was last edited.

IsSystemMessage optional bit

Set to 1 if the message should be displayed as a system message.

Default: 0.
Message optional string

Plaintext message. Mutually exclusive with MessageMarkdown.

MessageId mandatory int

Unique message id. Must be in a strictly ascending order. Will be used in the Store message and Delete message calls.

MessageMarkdown optional string

Message containing markdown. Mutually exclusive with Message.

ParticipantId optional string

An id corresponding to a participant in the Participants table. Mandatory if 'IsSystemMessage' is 0.

RemoveMessage optional bit

If set to 1 the message will be removed from the user interface if present.

Default: 0.
SentDatetimeUtc optional datetime

The datetime of when the message was sent. Mandatory if the column is present.

Resultset: Reload (optional)

Can be used when partial updates are not sufficient.

Can not be combined with the 'Messages' result set.

Table count: repeated zero or one time
Row count: exactly one row
Columns
Reload mandatory bit

Set to 1 to trigger a 'Get chat data' call.

Resultset: Sync Timestamp

Updated sync timestamp that will be sent as a parameter to the next client sync call.

Table count: repeated exactly once
Row count: exactly one row
Columns
SyncTimestamp mandatory string

The timestamp.

SQL Call: Validate parameters

Allows you to validate the SQL parameters before any other SQL is run in the component. This call is only made if the SQL is a stored procedure and Validate parameters is checked.

May modify database: No

Parameters

@Force bit
Set to 1 if the last call to validate parameters used admin_force and the user clicked OK in the OK/Cancel dialog.
@ValidateParams bit
Set to 1 when this call is made.

Resultset: Messages (optional)

Table count: repeated zero or one time
Row count: zero or one row
Columns
ADMIN_Force optional string
Message asking the end user to confirm their parameters.
ADMIN_Message optional string
Message explaining why the parameters are rejected.

InfoSQL

See the InfoSQL documentation for details.

Custom access control and logging

SQL Call: Custom access control and logging

Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.

Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.

The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.

If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.

May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.
Table count: repeated exactly once
Row count: exactly one row
Columns
GrantAccess mandatory bit
1 if the user is allowed to view the menu item, 0 if the user should not be allowed to view the menu item.

If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.

Querystring parameters

menuitemheading optional
String that replaces the menu item name when the menu item is loaded. It does not replace the name before that (like for example in the navigator). It is ignored if the menu item is displayed as a part in a multipart in which case the name can be set from the multipart procedure.