---
schema_version: "1"
id: a50c65b9b36eca0306dd861fdebf44c776b0657cdde7a0de9bd07325dc4e1211
title: ConnectApi.MentionCompletion
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_connectapi_output_mention_completion.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_mention_completion.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: c02b8c9ff79b851baeb73a00e136ec54f93ac4f743722c1c14a14160f915101a
description: Information about a record that could be used to @mention a user or group.
---
# ConnectApi.MentionCompletion

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

<table class="featureTable sort_table" summary="">




          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d1079258e47">Name</th>

              <th class="featureTableHeader vertical-align-top " id="d1079258e50">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d1079258e53">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d1079258e56">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1079258e47" data-title="Name"><samp class="codeph apex_code">additionalLabel</samp></td>

              <td class="entry" headers="d1079258e50" data-title="Type">String</td>

              <td class="entry" headers="d1079258e53" data-title="Description"><span class="ph" id="mentionCompletion_addLabel"><a name="mentionCompletion_addLabel"><!-- --></a>If one exists, an additional
                  label for the record represented by this completion, for
                  example, “(Customer)” or “(Acme
                  Corporation)”.</span></td>

              <td class="entry" headers="d1079258e56" data-title="Available Version">29.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d1079258e47" data-title="Name"><samp class="codeph apex_code">description</samp></td>

              <td class="entry" headers="d1079258e50" data-title="Type">String</td>

              <td class="entry" headers="d1079258e53" data-title="Description"><span class="ph" id="MentionCompletion_description"><a name="MentionCompletion_description"><!-- --></a>A description of the
                  record represented by this completion.</span></td>

              <td class="entry" headers="d1079258e56" data-title="Available Version">29.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d1079258e47" data-title="Name"><samp class="codeph apex_code">name</samp></td>

              <td class="entry" headers="d1079258e50" data-title="Type">String</td>

              <td class="entry" headers="d1079258e53" data-title="Description"><span class="ph" id="MentionCompletion_name"><a name="MentionCompletion_name"><!-- --></a>The name of the record
                  represented by this completion. The name is localized, if
                  possible.</span></td>

              <td class="entry" headers="d1079258e56" data-title="Available Version">29.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d1079258e47" data-title="Name"><samp class="codeph apex_code">outOfOffice</samp></td>

              <td class="entry" headers="d1079258e50" data-title="Type"><samp class="codeph apex_code"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_out_of_office.htm" title="User's out-of-office message.">ConnectApi.OutOfOffice</a></samp></td>

              <td class="entry" headers="d1079258e53" data-title="Description"><span class="ph" id="outOfOffice"><a name="outOfOffice"><!-- --></a>If the record represented by this completion
                  is a user, an additional out-of-office message, if one exists,
                  for the user.</span></td>

              <td class="entry" headers="d1079258e56" data-title="Available Version">40.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d1079258e47" data-title="Name"><samp class="codeph apex_code">photoUrl</samp></td>

              <td class="entry" headers="d1079258e50" data-title="Type">String</td>

              <td class="entry" headers="d1079258e53" data-title="Description"><span class="ph" id="MentionCompletion_photoUrl"><a name="MentionCompletion_photoUrl"><!-- --></a>A URL to the photo or icon of
                  the record represented by this completion.</span></td>

              <td class="entry" headers="d1079258e56" data-title="Available Version">29.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d1079258e47" data-title="Name"><samp class="codeph apex_code">recordId</samp></td>

              <td class="entry" headers="d1079258e50" data-title="Type">String</td>

              <td class="entry" headers="d1079258e53" data-title="Description"><span class="ph" id="MentionCompletion_recordId"><a name="MentionCompletion_recordId"><!-- --></a>The ID of the record
                  represented by this completion.</span></td>

              <td class="entry" headers="d1079258e56" data-title="Available Version">29.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d1079258e47" data-title="Name"><samp class="codeph apex_code">userType</samp></td>

              <td class="entry" headers="d1079258e50" data-title="Type">
                <samp class="codeph apex_code">ConnectApi.​UserType</samp>
                Enum
              </td>

              <td class="entry" headers="d1079258e53" data-title="Description">
                <span class="ph" id="MentionCompletion_userType"><a name="MentionCompletion_userType"><!-- --></a>If the record represented by
                  this completion is a user, this value is the user type
                  associated with that user; otherwise the value is <samp class="codeph apex_code"><span class="keyword">null</span></samp>.</span>
                <p class="p">One of these
                  values:</p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph apex_code">ChatterGuest</samp>—User is an external user in a private group.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">ChatterOnly</samp>—User is a Chatter Free customer.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">Guest</samp>—User is unauthenticated.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">Internal</samp>—User is a standard org member.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">Portal</samp>—User is an external user in an Experience Cloud site.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">System</samp>—User is Chatter Expert or a system user.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">Undefined</samp>—User is a user type that is a custom object.
                  </li>
                </ul>
              </td>

              <td class="entry" headers="d1079258e56" data-title="Available Version">30.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [ConnectApi.MentionCompletionPage](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_mention_completion_page.htm "Paginated list of Mention Completion response bodies.")