Version: 4.15.0

Event

Overview

brainCloud Events allow communication of custom messages between brainCloud users. By using the brainCloud Event API you are able to send and receive event objects. These events can encapsulate anything you want by using the custom JSON data payload.

When an Event is sent to a user, they can receive it in one of two ways:

By calling GetEvents which returns a list of all events sent to the authenticated user.
Through the registered event callback*. When executing any API call in brainCloud, the returned JSON from the server may contain new events for the user. By registering for notification of these events using the callback, you can be informed when these "piggybacked" events arrive. See the BrainCloudClient RegisterEventCallback method for more details.

* Note requires a brainCloud Plus Plan. Additional bulk API counts apply. To enable Event callbacks for all API calls, enable the "Enable checking for Incoming Events with each API message" compatibility flag.

API Summary

Retrieving Event

GetEvents - Get the events currently queued for the user.

Sending Event

SendEvent - Sends an event to the designated user ID with the attached json data.
SysSendEventRTTOnly - Sends an event to the designated user ID with the attached json data. Will only deliver the event via RTT. Will not persist the event.

Deleting Event

DeleteIncomingEvent - Delete an event out of the user's incoming mailbox.
DeleteIncomingEventsBy - Delete a list of events out of the user's incoming mailbox.
DeleteIncomingEvents - Delete a list of events out of the user's incoming mailbox.
DeleteIncomingEventsOlderThan - Delete any events older than the given date out of the user's incoming mailbox.
DeleteIncomingEventsByTypeOlderThan - Delete any events of the given type older than the given date out of the user's incoming mailbox.