FireDAC Components for Salesforce Chatter

Build 21.0.7930

Users

Retrieve User details.

Table Specific Information

Select

The component will use the Salesforce Chatter API to process filters based on the following columns: CommunityId, GroupId, Id (the primary key), or a combination of two Ids. Allowed operators are = and AND.

Filters on other columns are executed client side within the component. For example, the following queries are executed to the Salesforce Chatter APIs:

  • Return all users belonging to a group:
    SELECT * FROM Users WHERE GroupId = 'abc123'
  • Return only info related to a certain user:
    SELECT * FROM Users WHERE Id = 'myUserId'

You can also use the Salesforce Chatter API to filter through Users: Set the SearchTerms parameter to match DisplayName values. This parameter does not search not email addresses, titles, and so on.

SELECT * FROM Users WHERE SearchTerms = 'test?'

Note: The use of wildcards is permitted when filtering Users:

  • * matches zero or more characters at the middle or end of your search term.
  • ? matches only one character in the middle or end of your search term.
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to any other columns or operators will cause an error.

Columns

Name Type Description
Id [KEY] String The unique identifier of the user.
Username String The username associated with this account.
SearchTerms String Query to search the files database.
DisplayName String User's display name in the community.
Email String User's email address.
Name String User's full name.
FirstName String User's first name.
LastName String User's last name.
Title String User's title.
Type String User's type.
Url String The Url of the user account.
UserType String Specifies the type of user. Possible values are: 'ChatterGuest','ChatterOnly', 'Guest', 'Internal', 'Portal', 'System','Undefined'
AboutMe String The about me description for the user. The maximum length is 1000 characters.
City String Address city.
Country String User's country address.
FormattedAddress String FormattedAddress consists of State ZipCode and ISO 3166-1 alpha-2 letter Country code.
State String The US or Foreign State where the user lives.
Street String Street address.
Zip String The user's zip code.
BannerPhotoUrl String The user banner photo (aggregate value).
CommentCount Integer Number of user comments made.
CommentReceivedCount Integer Number of received comments.
LikeReceivedCount Integer Number of received likes.
PostCount Integer Number of user posts.
Percentile Double The Chatter Percentile compared with the other users.
Rank Integer Chatter rank.
Reputation Integer User's reputation scale.
CommunityNickname String The user's nickname in the community.
CompanyName String Company name.
FollowersCount Integer Number of followers.
FollowingPeople Integer Number of people this user is following.
FollowingRecords Integer Number of records this user is following.
FollowingTotal Integer Total number of entities this user is following.
GroupCount Integer Number of groups associated with the current user.
HasChatter Boolean Boolean value whether the current user has a Chatter available.
IsActive Boolean Boolean value whether the current user has an active account.
IsInThisCommunity Boolean Boolean value whether the current user belongs to a community.
PhoneNumbersAggregate String The user's phone number.
PhotoUrl String Information about the user photo (aggregate value).
ThanksReceived Integer Number of thanks received.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
IsMe Boolean Instead of specifying your exact Id, set this to true to retrieve your account information
GroupId String Id of the group associated with the current user.
CommunityId String Id of the community associated with the current user.
SearchContextId String Specify a feed item ID that provides context for the search results. Use this parameter for @mention completion. Passing a feed item ID for searchContextId matches users already mentioned in the thread earlier in the returned collection. You can also use the Mentions Completions resource, which is specifically designed for @mention completion. When using this parameter, you cannot query more than 500 results and you cannot use wildcards in the search term.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930