ChatterUsers クラス

getFollowings(String, String, Integer)

指定されたユーザのフォロワーに関する情報の指定されたページを返します。ページには、デフォルトの項目数が含まれます。これは、指定されたユーザをフォローしているユーザを返す getFollowers とは異なります。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, Integer pageParam)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

戻り値

getFollowings(String, String, Integer, Integer)

指定されたユーザのフォロワーに関する情報の特定のページを返します。これは、指定されたユーザをフォローしているユーザを返す getFollowers とは異なります。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, Integer pageParam, Integer pageSize)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getFollowings(String, String, String)

指定されたユーザの指定された種別のフォロワーに関する情報の最初のページを返します。ページには、デフォルトの項目数が含まれます。これは、指定されたユーザをフォローしているユーザを返す getFollowers とは異なります。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, String filterType)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。
filterType: 型: String; 返されるオブジェクトの種別を絞り込みするためのキープレフィックスを指定します。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。

戻り値

getFollowings(String, String, String, Integer)

指定されたユーザの指定された種別のフォロワーに関する情報の指定されたページを返します。ページには、デフォルトの項目数が含まれます。これは、指定されたユーザをフォローしているユーザを返す getFollowers とは異なります。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, String filterType, Integer pageParam)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。
filterType: 型: String; 返されるオブジェクトの種別を絞り込みするためのキープレフィックスを指定します。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

戻り値

getFollowings(String, String, String, Integer, Integer)

指定されたユーザの指定された種別のフォロワーに関する情報の指定されたページを返します。これは、指定されたユーザをフォローしているユーザを返す getFollowers とは異なります。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, String filterType, Integer pageParam, Integer pageSize)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。
filterType: 型: String; 返されるオブジェクトの種別を絞り込みするためのキープレフィックスを指定します。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getGroups(String, String)

指定されたユーザがメンバーであるグループの最初のページを返します。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupPage getGroups(String communityId, String userId)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。

戻り値

getGroups(String, String, Integer, Integer)

指定されたユーザがメンバーであるグループの指定されたページを返します。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupPage getGroups(String communityId, String userId, Integer pageParam, Integer pageSize)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getPhoto(String, String)

指定されたユーザの写真に関する情報を返します。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo getPhoto(String communityId, String userId)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。

戻り値

型: ConnectApi.Photo

getReputation(String, String)

指定されたユーザの評価を返します。

API バージョン

32.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Reputation getReputation(String communityId, String userId)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。

戻り値

型: ConnectApi.Reputation

getUser(String, String)

指定されたユーザに関する情報を返します。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserSummary getUser(String communityId, String userId)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。

戻り値

型: ConnectApi.UserSummary

使用方法

コンテキストユーザが Chatter 顧客でない場合は、返されたオブジェクトを UserDetail オブジェクトにダウンキャストできます。

getUserBatch(String, List<String>)

指定されたユーザリストに関する情報を取得します。ConnectApi.User オブジェクトを含む BatchResult オブジェクトのリストを返します。読み込みできないユーザの結果に含まれるエラーを返します。

API バージョン

31.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.BatchResult[] getUserBatch(String communityId, List<String> userIds)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userIds: 型: List<String>; 最大 500 件のユーザ ID のリスト。

戻り値

型: BatchResult[]

BatchResult getResults() メソッドは、ConnectApi.User オブジェクトを返します。

例

1swfobject.registerObject("clippy.codeblock-0", "9");// Get users in an organization.
2ConnectApi.UserPage userPage = ConnectApi.ChatterUsers.getUsers(null);
3
4// Create a list of user IDs.
5List<String> userList = new List<String>();
6for (ConnectApi.User user : userPage.users){
7    userList.add(user.id); 
8}
9
10// Get info about all users in the list.
11ConnectApi.BatchResult[] batchResults = ConnectApi.ChatterUsers.getUserBatch(null, userList);
12
13for (ConnectApi.BatchResult batchResult : batchResults) {
14    if (batchResult.isSuccess()) {
15        // Operation was successful. 
16        // Print each user's username.
17        ConnectApi.UserDetail user;
18        if(batchResult.getResult() instanceof ConnectApi.UserDetail) {
19            user = (ConnectApi.UserDetail) batchResult.getResult();
20        }
21        System.debug('SUCCESS');
22        System.debug(user.username);
23    }
24    else {
25        // Operation failed. Print errors.
26        System.debug('FAILURE');
27        System.debug(batchResult.getErrorMessage());
28    }
29}

getUsers(String)

ユーザの最初のページを返します。ページには、デフォルトの項目数が含まれます。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage getUsers(String communityId)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。

戻り値

getUsers(String, Integer, Integer)

ユーザの指定されたページを返します。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage getUsers(String communityId, Integer pageParam, Integer pageSize)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

searchUserGroups(String, String, String)

指定された検索条件と一致するグループの最初のページを返します。

API バージョン

30.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupPage searchUserGroups(String communityId, String userId, String q)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

コンテキストユーザがメンバーであるグループのページ設定されたリスト。

searchUserGroups(String, String, String, Integer, Integer)

指定された検索条件に一致するユーザの指定されたページを返します。

API バージョン

30.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupPage searchUserGroups(String communityId, String userId, String q, Integer pageParam, Integer pageSize)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
userId: 型: String; ユーザの ID。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

コンテキストユーザがメンバーであるグループのページ設定されたリスト。

searchUsers(String, String)

指定された検索条件と一致するユーザの最初のページを返します。ページには、デフォルトの項目数が含まれます。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage searchUsers(String communityId, String q)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

searchUsers(String, String, Integer, Integer)

指定された検索条件と一致するユーザの指定されたページを返します。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage searchUsers(String communityId, String q, Integer pageParam, Integer pageSize)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりのフィード項目��を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

searchUsers(String, String, String, Integer, Integer)

指定された検索条件と一致するユーザの指定されたページを返します。

API バージョン

28.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage searchUsers(String communityId, String q, String searchContextId, Integer pageParam, Integer pageSize)

パラメータ

communityId: 型: String; コミュニティの ID、internal、または null のいずれかを使用します。
q: 型: String; 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
searchContextId: 型: String; フィード @メンションの検索結果を絞り込むフィード項目 ID。最も役に立つ結果が最初に表示されます。この引数を指定する場合は、500 件を超える結果をクエリできず、検索語にワイルドカードも使用できません。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値