Messaging Client#
Callbacks for Messaging Client Component.
Callbacks#
Pre Display Message.
Display a message.
Cancel a message.
Callbacks Documentation#
sl_zigbee_af_messaging_client_pre_display_message_cb#
bool sl_zigbee_af_messaging_client_pre_display_message_cb (uint32_t messageId, uint8_t messageControl, uint32_t startTime, uint16_t durationInMinutes, uint8_t * message, uint8_t optionalExtendedMessageControl)
Pre Display Message.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | messageId | Ver.: always |
| uint8_t | N/A | messageControl | Ver.: always |
| uint32_t | N/A | startTime | Ver.: always |
| uint16_t | N/A | durationInMinutes | Ver.: always |
| uint8_t * | N/A | message | Ver.: always |
| uint8_t | N/A | optionalExtendedMessageControl | Ver.: always |
This function is called by the Messaging client plugin when a DisplayMessage command is received. If callback returns true, the plugin assumes the message have been handled and will not do anything with the message. Otherwise, the plugin will go through with its own implementation.
115 of file app/framework/plugin/messaging-client/messaging-client.hsl_zigbee_af_messaging_client_display_message_cb#
void sl_zigbee_af_messaging_client_display_message_cb (sl_zigbee_af_plugin_messaging_client_message_t * message)
Display a message.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_plugin_messaging_client_message_t * | N/A | message | The message that should be displayed. Ver.: always |
This function is called by the messaging client plugin whenever the application should display a message.
128 of file app/framework/plugin/messaging-client/messaging-client.hsl_zigbee_af_messaging_client_cancel_message_cb#
void sl_zigbee_af_messaging_client_cancel_message_cb (sl_zigbee_af_plugin_messaging_client_message_t * message)
Cancel a message.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_plugin_messaging_client_message_t * | N/A | message | The message that should no longer be displayed. Ver.: always |
This function is called by the messaging client plugin whenever the application should stop displaying a message.
136 of file app/framework/plugin/messaging-client/messaging-client.h