ConnectApi.MentionCompletion

Information about a record that could be used to @mention a user or group.

NameTypeDescriptionAvailable Version
additionalLabelStringIf one exists, an additional label for the record represented by this completion, for example, “(Customer)” or “(Acme Corporation)”.29.0
descriptionStringA description of the record represented by this completion.29.0
nameStringThe name of the record represented by this completion. The name is localized, if possible.29.0
outOfOfficeConnectApi.OutOfOfficeIf the record represented by this completion is a user, an additional out-of-office message, if one exists, for the user.40.0
photoUrlStringA URL to the photo or icon of the record represented by this completion.29.0
recordIdStringThe ID of the record represented by this completion.29.0
userTypeConnectApi.​UserType EnumIf the record represented by this completion is a user, this value is the user type associated with that user; otherwise the value is null.
One of these values:
  • ChatterGuest—User is an external user in a private group.
  • ChatterOnly—User is a Chatter Free customer.
  • Guest—User is unauthenticated.
  • Internal—User is a standard org member.
  • Portal—User is an external user in an Experience Cloud site.
  • System—User is Chatter Expert or a system user.
  • Undefined—User is a user type that is a custom object.
30.0

See Also