Mentions allow users to tag other users in messages, comments, and posts. It's a powerful tool for fostering engagement and collaboration within your social application. With mentions, users can easily direct messages to specific individuals or groups and can alert them to new content or important updates. In the SDK, mentions can be implemented in a range of ways, depending on your application's needs and user experience. Here are the models that support mentions creation and highlighting:

you have the flexibility to define your own mention data structure for representing mentions. This allows you to highlight mentioned text in a way that best suits the needs of your application and users. The most important aspect of mentions is to notify users when they have been mentioned, regardless of the specific data structure used. This ensures that users are able to quickly and easily engage with the content that is most relevant to them.

Mention Users

Upon creating a model above (a post, comment, or message) with a mention, you can include a JSON object in the metadata parameter. The metadata represents the mention object, which depends on the design of your data structure. However, Amity provides a default structure to help you create the mention metadata.

To ensure prompt notification of the person mentioned, it's important to provide the list of user IDs for the mention users parameter. This will help ensure that the mentioned users are notified and able to engage with the content.

  • mentionUsers(userIds) - In order to mention users and notify specific users. This function supports all mentionable models.

  • mentionChannel(channelId) - In order to mention and notify the whole channel. This function supports only a message model.

  • metadata - a flexible JSON object which can accommodate any information regarding the mentioned users. Our default structure for representing mentions is also in the metadata property.

Default Mention Metdata Structure

To represent mentions using our structure, you will need to utilize the AmityMention object. This object can be created during mentionable model creation, as well as during rendering. The model contains of four properties:

  • type - type of the mention - the possible types are user and channel, for post and comment only support mentioning user but message supports mention channel additionally.

  • index - start index of current mention

  • userId - userId of the user being mentioned. If the type of the mention is channel, then userId is undefined.

  • length - length of the mention

The length property doesn’t include the “@“ mention sign. For example, “@all” mention’s length is 3.

Mention Users Example

Below is an example to create a comment with mentions by using our default mention metadata structure:

We do not allow banned users to be mentioned, as we take a firm stance against harmful or inappropriate content in social applications. However, admins may still be able to access the names of banned users through the search users function. Once a message is sent, however, banned users' information will be excluded from the payload. Banned users will also not be notified or receive any push notifications if they are mentioned, further ensuring that they do not engage with the content.

Render Mentions

As we mentioned that we provided the flexibility for you to define your own mention object data structure to represent mentions. You can use the default data structure provided by the SDK to render mentions in your application, which can be accessed through the helper class. This allows you easily retrieve mentions and render them. The mentionable model contains properties related to the mention feature:

  • mentionUsers - The AmityUser object array contains details about users mentioned in the current content.

  • metadata - a flexible JSON object which can accommodate any information regarding the mentioned users. Our predefined structure for representing mentions is also in the metadata property.

Below is an example to render mentions in a comment by using our default mention data structure:

The following example demonstrate how AmityMentionMapper and AmityMention works in a comment. The function getAttributedString uses AmityMentionMapper to extract AmityMention from metadata, and return the highlighted text.

Mention Notifications

When users are being mentioned, they will receive push notifications. You can customize the push notification content such as the title and the body using the notification setting API. Providing the notification title and body in the titleTemplate and bodyTemplate parameters respectively. Here is a sample model:

  "level": "network",
  "isPushNotifiable": true,
  "notifiableEvents": [
      "name": "text-mention-message.created",
      "isPushNotifiable": true,
      "titleTemplate": "{{UserDisplayName}} mentioned you in {{ChannelName}}",
      "bodyTemplate": "{{Message}}"

Last updated