Skip to main content
Version: 5.7.0

Messaging

API Summary​

Messaging​

  • SysGetMessagesPage - Gets the page of system messages from the server based on the encoded context.
  • SysGetMessagesPageOffset - Gets the page of system messages from the server based on the encoded context and specified page offset.
  • SysGetMessages - Retrieves list of specified system messages.
  • SysUpdateMessage - Updates a system message.
  • SysDeleteMessage - Deletes specified system message on the server. Note, if a regular message, deletes all references to it.
  • SysDeleteMessages - Deletes specified system messages on the server. Note, if a regular message, deletes all references to it.
  • SysSendMessageSimple - Sends a simple string-based message on behalf of the system (i.e. app) to the specified users.
  • SysSendMessage - Sends a message on behalf of the system (i.e. app) to the specified users.
  • SysGetMessagesForOwnerPage - Retrieves the page of messages, owned by specified ownerId, from the server based on the encoded context.
  • SysGetMessagesForOwnerPageOffset - Retrieves the page of messages, owned by specified ownerId, from the server based on the encoded context and specified page offset.
tip

All the client APIs that the names beigin with "Sys" are also available to S2S. For the usages of the S2S messaging APIs (if they are not listed at this section below), refer to brainCloud client messaging APIs.

Last updated on by Jason Liang