Mention other users in a message

In both group channels and open channels, a user can mention other users in a message to call their attention. Users have the option of calling specific users in the channel by their user IDs or calling all users in the channel.

Up to ten mentioned users are notified when mentioned. Notification preferences for mentions can be configured for each user in a channel.

To mention specific users when sending a message, add a list of user IDs to mentionedUserIds. Then, add the list to UserMessageCreateParams or FileMessageCreateParams and pass the params to sendUserMessage() or sendFileMessage(), respectively.

Mentioned users must belong to the channel where the message is being sent. Users who are mentioned but don't belong to the channel won't be included in the mentioned user IDs array of the sent message.

const params: UserMessageCreateParams = {
    message: MESSAGE;
    mentionedUserIds: ['Harry', 'Jay', 'Jin'],
};

channel.sendUserMessage(params)
  .onPending((message: UserMessage) => {
    // ...
  })
  .onFailed((err: Error, message: UserMessage) => {
    // ...
  })
  .onSucceeded((message: UserMessage) => {
    // ...
  });

When a user types "@channel" or other designated text in a message, you can set mentionType to MentionType.CHANNEL and let the user call the attention of everyone in the channel.

const params: UserMessageCreateParams = {
    message: MESSAGE,
    mentionType: MentionType.CHANNEL,
};

channel.sendUserMessage(params)
  .onPending((message: UserMessage) => {
    // ...
  })
  .onFailed((err: Error, message: UserMessage) => {
    // ...
  })
  .onSucceeded((message: UserMessage) => {
    // ...
  });

Using channel mention is subject to the following limitations.