Mentions

Add user mentions to CometChat messages in one-on-one and group chats using UID-based mention syntax.

Mentions in messages enable users to refer to specific individual within a conversation. This is done by using the <@uid:UID> format, where UID represents the user’s unique identification.

Mentions are a powerful tool for enhancing communication in messaging platforms. They streamline interaction by allowing users to easily engage and collaborate with particular individuals, especially in group conversations.

Send Mentioned Messages

To send a message with a mentioned user, you must follow a specific format: <@uid:UID>. For example, to mention the user with UID cometchat-uid-1 with the message “Hello,” your text would be "Hello, <@uid:cometchat-uid-1>"

TypeScript (User)

let receiverID: string = "UID";
let messageText: string = "Hello <@uid:cometchat-uid-1>";
let receiverType: string = CometChat.RECEIVER_TYPE.USER;
let textMessage: CometChat.TextMessage = new CometChat.TextMessage(receiverID, messageText, receiverType);

CometChat.sendMessage(textMessage).then(
(message: CometChat.TextMessage) => {
console.log("Message sent successfully:", message);
}, (error: CometChat.CometChatException) => {
console.log("Message sending failed with error:", error);
}
);

JavaScript (User)

let receiverID = "UID";
let messageText = "Hello, <@uid:cometchat-uid-1>";
let receiverType = CometChat.RECEIVER_TYPE.USER;
let textMessage = new CometChat.TextMessage(
  receiverID,
  messageText,
  receiverType
);

CometChat.sendMessage(textMessage).then(
  (message) => {
    console.log("Message sent successfully:", message);
  },
  (error) => {
    console.log("Message sending failed with error:", error);
  }
);

TypeScript (Group)

let receiverID: string = "GUID",
  messageText: string = "Hello world!",
  receiverType: string = CometChat.RECEIVER_TYPE.GROUP,
  textMessage: CometChat.TextMessage = new CometChat.TextMessage(
    receiverID,
    messageText,
    receiverType
  );

CometChat.sendMessage(textMessage).then(
(message: CometChat.TextMessage) => {
console.log("Message sent successfully:", message);
},
(error: CometChat.CometChatException) => {
console.log("Message sending failed with error:", error);
}
);

JavaScript (Group)

let receiverID = "GUID";
let messageText = "Hello <@uid:cometchat-uid-1>";
let receiverType = CometChat.RECEIVER_TYPE.GROUP;
let textMessage = new CometChat.TextMessage(
  receiverID,
  messageText,
  receiverType
);

CometChat.sendMessage(textMessage).then(
  (message) => {
    console.log("Message sent successfully:", message);
  },
  (error) => {
    console.log("Message sending failed with error:", error);
  }
);

You can mention user in text message and media messages captions

Mentioned Messages

By default, the SDK will fetch all the messages irrespective of the fact that the logged-in user is mentioned or not in the message. The SDK has other optional filters such as tags and blocked relationships.

Setting	Description
mentionsWithTagInfo(boolean value)	If set to true, SDK will fetch a list of messages where users are mentioned & will also fetch the tags of the mentioned users. Default value = false.
mentionsWithBlockedInfo(boolean value)	If set to true, SDK will fetch a list of messages where users are mentioned & will also fetch their blocked relationship with the logged-in user. Default value = false.

Mentions With Tag Info

To get a list of messages in a conversation where users are mentioned along with the user tags of the mentioned users.

TypeScript (User)

let UID: string = "UID",
  limit: number = 30,
  messagesRequest: CometChat.MessagesRequest =
    new CometChat.MessagesRequestBuilder()
      .setUID(UID)
      .setLimit(limit)
      .mentionsWithTagInfo(true)
      .build();

messagesRequest.fetchPrevious().then(
(messages: CometChat.BaseMessage[]) => {
messages.forEach((eachMessage: CometChat.BaseMessage) => {
eachMessage
.getMentionedUsers()
.forEach((eachMentionedUser: CometChat.User) => {
console.log(eachMentionedUser.getTags());
});
});
},
(error) => {
console.log("Message fetching failed with error:", error);
}
);

JavaScript (User)

let UID = "UID";
let limit = 30;

let messagesRequest = new CometChat.MessagesRequestBuilder()
  .setUID(UID)
  .setLimit(limit)
  .mentionsWithTagInfo(true)
  .build();

messagesRequest.fetchPrevious().then(
  (messages) => {
    messages.forEach((eachMessage) => {
      eachMessage.getMentionedUsers().forEach((eachMentionedUser) => {
        console.log(eachMentionedUser.getTags());
      });
    });
  },
  (error) => {
    console.log("Message fetching failed with error:", error);
  }
);

TypeScript (Group)

let GUID: string = "GUID",
  limit: number = 30,
  messagesRequest: CometChat.MessagesRequest =
    new CometChat.MessagesRequestBuilder()
      .setGUID(GUID)
      .setLimit(limit)
      .mentionsWithTagInfo(true)
      .build();

messagesRequest.fetchPrevious().then(
(messages: CometChat.BaseMessage[]) => {
messages.forEach((eachMessage: CometChat.BaseMessage) => {
eachMessage
.getMentionedUsers()
.forEach((eachMentionedUser: CometChat.User) => {
console.log(eachMentionedUser.getTags());
});
});
},
(error) => {
console.log("Message fetching failed with error:", error);
}
);

JavaScript (Group)

let GUID = "GUID";
let limit = 30;

let messagesRequest = new CometChat.MessagesRequestBuilder()
  .setGUID(GUID)
  .setLimit(limit)
  .mentionsWithTagInfo(true)
  .build();

messagesRequest.fetchPrevious().then(
  (messages) => {
    messages.forEach((eachMessage) => {
      eachMessage.getMentionedUsers().forEach((eachMentionedUser) => {
        console.log(eachMentionedUser.getTags());
      });
    });
  },
  (error) => {
    console.log("Message fetching failed with error:", error);
  }
);

Relevant fields to access on returned messages and their mentioned users:

Field	Getter	Return Type	Description
mentionedUsers	getMentionedUsers()	User[]	Array of users mentioned in the message
tags (on each mentioned user)	getTags()	string[]	Tags associated with the mentioned user

Mentions With Blocked Info

To get a list of messages in a conversation where users are mentioned along with the blocked relationship of the mentioned users with the logged-in user.

Relevant fields to access on returned messages and their mentioned users:

Field	Getter	Return Type	Description
mentionedUsers	getMentionedUsers()	User[]	Array of users mentioned in the message
blockedByMe (on each mentioned user)	getBlockedByMe()	boolean	Whether the logged-in user has blocked this mentioned user
hasBlockedMe (on each mentioned user)	getHasBlockedMe()	boolean	Whether this mentioned user has blocked the logged-in user

TypeScript (User)

let UID: string = "UID",
  limit: number = 30,
  messagesRequest: CometChat.MessagesRequest =
    new CometChat.MessagesRequestBuilder()
      .setUID(UID)
      .setLimit(limit)
      .mentionsWithBlockedInfo(true)
      .build();

messagesRequest.fetchPrevious().then(
(messages: CometChat.BaseMessage[]) => {
messages.forEach((eachMessage: CometChat.BaseMessage) => {
eachMessage
.getMentionedUsers()
.forEach((eachMentionedUser: CometChat.User) => {
console.log("blockedByMe: " + eachMentionedUser.getBlockedByMe());
console.log("hasBlockedMe: " + eachMentionedUser.getHasBlockedMe());
});
});
},
(error) => {
console.log("Message fetching failed with error:", error);
}
);

JavaScript (User)

let UID = "UID";
let limit = 30;

let messagesRequest = new CometChat.MessagesRequestBuilder()
  .setUID(UID)
  .setLimit(limit)
  .mentionsWithBlockedInfo(true)
  .build();

messagesRequest.fetchPrevious().then(
  (messages) => {
    messages.forEach((eachMessage) => {
      eachMessage.getMentionedUsers().forEach((eachMentionedUser) => {
        console.log("blockedByMe: " + eachMentionedUser.getBlockedByMe());
        console.log("hasBlockedMe: " + eachMentionedUser.getHasBlockedMe());
      });
    });
  },
  (error) => {
    console.log("Message fetching failed with error:", error);
  }
);

TypeScript (Group)

let GUID: string = "GUID",
  limit: number = 30,
  messagesRequest: CometChat.MessagesRequest =
    new CometChat.MessagesRequestBuilder()
      .setGUID(GUID)
      .setLimit(limit)
      .mentionsWithBlockedInfo(true)
      .build();

messagesRequest.fetchPrevious().then(
(messages: CometChat.BaseMessage[]) => {
messages.forEach((eachMessage: CometChat.BaseMessage) => {
eachMessage
.getMentionedUsers()
.forEach((eachMentionedUser: CometChat.User) => {
console.log("blockedByMe: " + eachMentionedUser.getBlockedByMe());
console.log("hasBlockedMe: " + eachMentionedUser.getHasBlockedMe());
});
});
},
(error) => {
console.log("Message fetching failed with error:", error);
}
);

JavaScript (Group)

let GUID = "GUID";
let limit = 30;

let messagesRequest = new CometChat.MessagesRequestBuilder()
  .setGUID(GUID)
  .setLimit(limit)
  .mentionsWithBlockedInfo(true)
  .build();

messagesRequest.fetchPrevious().then(
  (messages) => {
    messages.forEach((eachMessage) => {
      eachMessage.getMentionedUsers().forEach((eachMentionedUser) => {
        console.log("blockedByMe: " + eachMentionedUser.getBlockedByMe());
        console.log("hasBlockedMe: " + eachMentionedUser.getHasBlockedMe());
      });
    });
  },
  (error) => {
    console.log("Message fetching failed with error:", error);
  }
);

Get Users Mentioned In a Particular Message

To retrieve the list of users mentioned in the particular message, you can use the message.getMentionedUsers() method. This method will return an array containing the mentioned users, or an empty array if no users were mentioned in the message.

message.getMentionedUsers();

The getMentionedUsers() method returns an array of User objects.

---

Next Steps

Send Messages

Send text, media, and custom messages

Receive Messages

Listen for incoming messages in real time

Reactions

Add emoji reactions to messages

Threaded Messages

Organize conversations with message threads