Mentions クラス

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.MentionCompletionPage getMentionCompletions (String communityId, String q, String contextId)

パラメータ

communityId

型: String

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

q

型: String

検索語。一致するユーザおよびグループの名前を検索します。ユーザを検索する場合、1 文字以上を指定する必要があります。グループを検索する場合、2 文字以上を指定する必要があります。このパラメータではワイルドカードは使用できません。

contextId

型: String

検索結果を絞り込むフィード項目 ID (コメント内のメンションの場合) またはフィード件名 ID (フィード項目内のメンションの場合) であり、最も的確な結果が最初に表示されます。顧客がメンションの補完結果に顧客を含めることができるグループのグループ ID を使用します。

戻り値

型: ConnectApi.​MentionCompletion​Page

使用方法

ユーザがフィード項目本文またはコメント本文に文字を入力すると選択可能になる提案メンションのページを生成するには、このメソッドをコールします。

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Mentions getMentionCompletions (String communityId, String q, String contextId, ConnectApi.MentionCompletionType type, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

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

q

型: String

検索語。一致するユーザおよびグループの名前を検索します。ユーザを検索する場合、1 文字以上を指定する必要があります。グループを検索する場合、2 文字以上を指定する必要があります。このパラメータではワイルドカードは使用できません。

contextId

型: String

検索結果を絞り込むフィード項目 ID (コメント内のメンションの場合) またはフィード件名 ID (フィード項目内のメンションの場合) であり、最も的確な結果が最初に表示されます。顧客がメンションの補完結果に顧客を含めることができるグループのグループ ID を使用します。

type

型: ConnectApi.MentionCompletionType

メンションの補完の種類を指定します。

• All — メンションで参照するレコードタイプに無関係の、すべてのメンションの補完。
• Group — グループのメンションの補完。
• User — ユーザのメンションの補完。

pageParam

型: String

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: String

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.​MentionCompletion​Page

使用方法

ユーザがフィード項目本文またはコメント本文に文字を入力すると選択可能になる提案メンションのページを生成するには、このメソッドをコールします。

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Mentions getMentionValidations(String communityId, String parentId, List<String> recordIds, ConnectApi.FeedItemVisibilityType visibility)

パラメータ

communityId

型: String

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

parentId

型: String

フィード項目の親 ID (新しいフィード項目の場合) またはフィード項目 ID (コメントの場合)。

recordIds

型: List<String>

メンションする ID のカンマ区切りのリスト。最大値は、25 です。

visibility

型: ConnectApi.FeedItemVisibilityType

フィード項目を表示できるユーザの種別を指定します。

• AllUsers — 表示は内部ユーザに限定されません。
• InternalUsers — 表示は内部ユーザに限定されます。

戻り値

型: ConnectApi.​​Mention​Validations

使用方法

このメソッドをコールして、ConnectApi.Mentions.getMentionCompletions へのコールから返されたレコード ID がコンテキストユーザに対して有効かどうかを確認します。たとえば、コンテキストユーザは自分が属していない非公開グループにメンションできません。そのようなグループがメンションの検証のリストに含まれていると、ConnectApi.MentionValidations.hasErrors プロパティは true になり、グループの ConnectApi.MentionValidation.valdiationStatus が Disallowed に設定されます。

API バージョン

29.0

署名

public static Void setTestGetMentionCompletions (String communityId, String q, String contextId, ConnectApi.MentionCompletionPage result)

パラメータ

communityId

型: String

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

q

型: String

検索語。一致するユーザおよびグループの名前を検索します。ユーザを検索する場合、1 文字以上を指定する必要があります。グループを検索する場合、2 文字以上を指定する必要があります。このパラメータではワイルドカードは使用できません。

contextId

型: String

検索結果を絞り込むフィード項目 ID (コメント内のメンションの場合) またはフィード件名 ID (フィード項目内のメンションの場合) であり、最も的確な結果が最初に表示されます。顧客がメンションの補完結果に顧客を含めることができるグループのグループ ID を使用します。

result

型: ConnectApi.​MentionCompletion​Page

テストデータを含む ConnectApi.MentionCompletionPage オブジェクト。

戻り値

型: Void

API バージョン

29.0

署名

public static Void setTestGetMentionCompletions (String communityId, String q, String contextId, ConnectApi.MentionCompletionType type, Integer pageParam, Integer pageSize, ConnectApi.MentionCompletionPage result)

パラメータ

communityId

型: String

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

q

型: String

検索語。一致するユーザおよびグループの名前を検索します。ユーザを検索する場合、1 文字以上を指定する必要があります。グループを検索する場合、2 文字以上を指定する必要があります。このパラメータではワイルドカードは使用できません。

contextId

型: String

検索結果を絞り込むフィード項目 ID (コメント内のメンションの場合) またはフィード件名 ID (フィード項目内のメンションの場合) であり、最も的確な結果が最初に表示されます。顧客がメンションの補完結果に顧客を含めることができるグループのグループ ID を使用します。

type

型: ConnectApi.MentionCompletionType

メンションの補完の種類を指定します。

• All — メンションで参照するレコードタイプに無関係の、すべてのメンションの補完。
• Group — グループのメンションの補完。
• User — ユーザのメンションの補完。

pageParam

型: String

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: String

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

result

型: ConnectApi.​MentionCompletion​Page

テストデータを含む ConnectApi.MentionCompletionPage オブジェクト。

戻り値

型: Void