Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

ConnectApi.MentionCompletion Class

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

Name	Type	Description	Available Version
`additionalLabel`	String	An additional label (if one exists) for the record represented by this completion, for example, “(Customer)” or “(Acme Corporation)”.	29.0
`description`	String	A description of the record represented by this completion.	29.0
`name`	String	The name of the record represented by this completion. The name is localized, if possible.	29.0
`outOfOffice`	`ConnectApi.OutOfOffice (Pilot)`	If the record represented by this completion is a user, an additional out-of-office message, if one exists, for the user. We provide Out of Office to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to change, and we can’t guarantee acceptance. Out of Office isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. Note	40.0
`photoUrl`	String	A URL to the photo or icon of the record represented by this completion.	29.0
`recordId`	String	The ID of the record represented by this completion.	29.0
`userType`	`ConnectApi.UserType` Enum	If 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 organization member. `Portal`—User is an external user in a customer portal, partner portal, or community. `System`—User is Chatter Expert or a system user. `Undefined`—User is a user type that is a custom object.	30.0