MessagingAPI.MessageSender Class Reference
Detailed Description
The MessageSender class defines the interface for creating and sending messages.
Any class that needs to send messages should derive from this class.
A derived class may wish to override the createMessage() and/or the sendMessage() method to define different implementations for creating and sending messages, or to extend the current implementations.
#include
<class_messaging_a_p_i_1_1_message_sender.h>
Public Member Functions |
|
| setMessagingImplementation () | |
| getMessagingImplementation () | |
| createMessage () | |
| createMessageFromString () | |
| createMessagesFromStrings () | |
| createMessageDataFromString () | |
| sendMessageBundle () | |
| Sends the given messages as a single bundle.
|
|
| sendMessage () | |
| Sends a message. |
|
Member Function Documentation
| MessagingAPI.MessageSender.setMessagingImplementation | ( | ) |
| MessagingAPI.MessageSender.getMessagingImplementation | ( | ) |
| MessagingAPI.MessageSender.createMessage | ( | ) |
| MessagingAPI.MessageSender.createMessageFromString | ( | ) |
| MessagingAPI.MessageSender.createMessagesFromStrings | ( | ) |
| MessagingAPI.MessageSender.createMessageDataFromString | ( | ) |
| MessagingAPI.MessageSender.sendMessageBundle | ( | ) |
Sends the given messages as a single bundle.
| MessagingAPI.MessageSender.sendMessage | ( | ) |
Sends a message.
It can be called one of two ways: 1) sender.sendMessage( messageId, messageData ), where:
- messageId is a string representing the message id
- messageData is a tuple representing the message data 2) sender.sendMessage( message ), where:
- message is a message created using sender.createMessage()
An optional keyword argument, requestUndo, specifies whether undo will be enabled for this message. By default, requestUndo is set to True,
Returns the sent message, or None if the message could not be created.
Reimplemented in Joystick.GameController, and Joystick.Joystick.
