Skip Navigation

Newer Version Available

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

ConnectApi.User Class

This class is abstract.

Subclass of ConnectApi.ActorWithId Class

Superclass of:

Name	Type	Description	Available Version
`additionalLabel`	String	An extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” If the user doesn’t have an extra label, the value is `null`.	30.0
`communityNickname`	String	User’s nickname in the community.	32.0
`companyName`	String	Name of the company. If your community allows access without logging in, the value is `null` for guest users.	28.0
`displayName`	String	User’s name that is displayed in the community. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed.	32.0
`firstName`	String	User's first name. In version 39.0 and later, if nicknames are enabled, `firstName` is `null`.	28.0
`isChatterGuest`	Boolean	`true` if user is a Chatter customer; `false` otherwise.	28.0
`isInThisCommunity`	Boolean	`true` if user is in the same community as the context user; `false` otherwise	28.0
`lastName`	String	User's last name. In version 39.0 and later, if nicknames are enabled, `lastName` is `null`.	28.0
`outOfOffice`	`ConnectApi.OutOfOffice (Pilot)`	Extra 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
`photo`	`ConnectApi.Photo`	Information about the user's photos.	28.0
`reputation`	`ConnectApi.Reputation Class`	Reputation of the user.	32.0
`stamps`	List<`ConnectApi.Stamp`>	Collection of the user’s stamps.	39.0
`title`	String	User’s title. If your community allows access without logging in, the value is `null` for guest users.	28.0
`userType`	`ConnectApi.UserType` Enum	Specifies the type of user. `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.	28.0