Skip to main content

Chat / Unreal

Current version: v3

Overview
- Application
- Overview
- - Authenticating a user
  - Authentication
- - Understanding rate limits
  - Rate limits
- Users
- Overview
- - Managing user metadata
  - Create user metadata
  - Retrieve user metadata
  - Update user metadata
  - Delete user metadata
- - Managing operators in an open channel
  - Register and remove operators
- - Updating user profile
  - Update user profile
- Channels
- Overview
- - Creating a channel
  - Create an open channel
  - Create a group channel
- - Retrieving channels
  - Retrieve a list of channels
  - Retrieve a channel by URL
- - Joining and leaving a group channel
  - Join and leave a channel
- - Inviting users to a group channel
  - Invite users as members
  - Accept or decline an invitation
- - Searching channels
  - Search open channels by name or URL
  - Search group channels by name, URL, or other filters
  - Filter channels by user IDs
- - Managing channels
  - Add a channel cover image
  - Categorize channels by custom type
- - Managing channel metadata
  - Create channel metadata
  - Retrieve channel metadata
  - Update channel metadata
  - Delete channel metadata
- - Managing channel metacounter
  - Create channel metacounter
  - Retrieve channel metacounter
  - Update channel metacounter
  - Delete channel metacounter
  - Increase channel metacounter
  - Decrease channel metacounter
- Messages
- Overview
- - Managing a message
  - Send a message in open channel
  - Send a message in group channel
  - Copy a message
  - Update a message
  - Delete a message
- - Loading messages
  - Load previous messages
  - Load messages by timestamp or message ID
- - Receiving messages in group channel
  - Receive messages through channel event handler
- - Marking messages as read
  - Mark messages as read
- - Mentioning other users in a message
  - Mention other participants or members
- - Getting statistics on unread messages
  - Retrieve a number of unread messages in a group channel
  - Retrieve a number of unread messages in all group channels
  - Retrieve a number of group channels with unread messages
- - Categorizing messages
  - Categorize messages by custom type
- - Adding extra data to a message
  - Add extra data to a message
- - Translating messages
  - Message auto-translation
  - Translation engine
- Event handler
- Overview
- - Managing channel handler
  - Add and remove a channel handler
- - Managing connection handler
  - Add and remove a connection handler
- - Managing user event handler
  - Add and remove a user event handler
Error codes

Chat Unreal v3

Chat Unreal

Chat

Unreal

Home

/

Chat

/

Unreal

/

Messages

Mention other participants or members

When a participant or a member wants to call the attention of other participants or members in a channel, they are able to mention others in a message by following the steps below:

Specify a list of the user IDs to mention.
Add the list to SBDUserMessageParams which may contain options for further action.
Pass the params to SendUserMessage().
Only up to 10 participants or members who are mentioned will be notified through SBDChannelHandler's MentionReceived().

Open channelGroup channel

std::vector<std::wstring> userIDsToMention;
userIDsToMention.push_back(L"Jane");
userIDsToMention.push_back(L"Julia");
userIDsToMention.push_back(L"Tyler");

SBDUserMessageParams params = SBDUserMessageParams()
        .SetMessage(MESSAGE)
        .SetMentionedUserIds(userIDsToMention);

openChannel->SendUserMessage(params, [](SBDUserMessage* userMessage, SBDError* error) {
    if (error != nullptr) {
        // Handle error.
        return;
    }
});

Sample app