Messaging Client#

Callbacks for Messaging Client Component.

Callbacks#

bool
emberAfPluginMessagingClientPreDisplayMessageCallback(uint32_t messageId, uint8_t messageControl, uint32_t startTime, uint16_t durationInMinutes, uint8_t *message, uint8_t optionalExtendedMessageControl)

Pre Display Message.

void
emberAfPluginMessagingClientDisplayMessageCallback(EmberAfPluginMessagingClientMessage *message)

Display a message.

void
emberAfPluginMessagingClientCancelMessageCallback(EmberAfPluginMessagingClientMessage *message)

Cancel a message.

Callbacks Documentation#

emberAfPluginMessagingClientPreDisplayMessageCallback#

bool emberAfPluginMessagingClientPreDisplayMessageCallback (uint32_t messageId, uint8_t messageControl, uint32_t startTime, uint16_t durationInMinutes, uint8_t * message, uint8_t optionalExtendedMessageControl)

Pre Display Message.

Parameters
N/AmessageId

Ver.: always

N/AmessageControl

Ver.: always

N/AstartTime

Ver.: always

N/AdurationInMinutes

Ver.: always

N/Amessage

Ver.: always

N/AoptionalExtendedMessageControl

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.


Definition at line 115 of file app/framework/plugin/messaging-client/messaging-client.h

emberAfPluginMessagingClientDisplayMessageCallback#

void emberAfPluginMessagingClientDisplayMessageCallback (EmberAfPluginMessagingClientMessage * message)

Display a message.

Parameters
N/Amessage

The message that should be displayed. Ver.: always

This function is called by the messaging client plugin whenever the application should display a message.


Definition at line 128 of file app/framework/plugin/messaging-client/messaging-client.h

emberAfPluginMessagingClientCancelMessageCallback#

void emberAfPluginMessagingClientCancelMessageCallback (EmberAfPluginMessagingClientMessage * message)

Cancel a message.

Parameters
N/Amessage

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.


Definition at line 136 of file app/framework/plugin/messaging-client/messaging-client.h