Apex 開発者ガイド
jKnowledgeSuggestionFilter クラス
SOSL 検索クエリに KnowledgeArticleVersion オブジェクトが含まれている場合、System.Search.suggest(searchQuery, sObjectType, options) へのコール結果を絞り込む検索条件設定。
名前空間
KnowledgeSuggestionFilter のメソッド
KnowledgeSuggestionFilter のメソッドは次のとおりです。
addArticleType(articleType)
署名
public void addArticleType(String articleType)
パラメーター
- articleType
- 型: String
- 目的の記事タイプを示す 3 文字の ID プレフィックス。
戻り値
型: void
使用方法
記事タイプを 2 つ以上追加するには、メソッドを複数回コールします。
addDataCategory(dataCategoryGroupName, dataCategoryName)
署名
public void addDataCategory(String dataCategoryGroupName, String dataCategoryName)
戻り値
型: void
使用方法
複数のデータカテゴリを設定するには、メソッドを複数回コールします。対応付けとして表現された、目的の記事のデータカテゴリグループの名前とデータカテゴリの名前 (Search.KnowledgeSuggestionFilter.addDataCategory('Regions', 'Asia') など)。
addTopic(topic)
署名
public void addTopic(String topic)
パラメーター
- addTopic
- 型: String
- 記事トピックの名前。
戻り値
型: void
使用方法
記事トピックを 2 つ以上追加するには、メソッドを複数回コールします。
setChannel(channelName)
署名
public void setChannel(String channelName)
パラメーター
- channelName
- 型: String
- チャネルの名前。有効な値は、次のとおりです。
- AllChannels – ユーザーがアクセス権を持つすべてのチャネルで参照可能
- App – 内部 Salesforce ナレッジアプリケーションで参照可能
- Pkb – 公開知識ベースで参照可能
- Csp – カスタマーポータルで参照可能
- Prm – パートナーポータルで参照可能
channel が指定されていない場合、ユーザーの種別によってデフォルト値が決まります。- ゲストユーザーの Pkb
- カスタマーポータルユーザーの Csp
- パートナーポータルユーザーの Prm
- 他の種別のユーザーの App
channel が指定されている場合、特定の要件により、指定された値が要求した実際の値にならないことがあります。- ゲストユーザー、カスタマーポータルユーザー、パートナーポータルユーザーの場合、指定された値は各ユーザー種別のデフォルト値と一致する必要があります。値が一致しないか、AllChannels が指定されていると、指定された値が App に置き換えられます。
- ゲストユーザー、カスタマーポータルユーザー、パートナーポータルユーザー以外のすべてのユーザーの場合は、次のようになります。
- Pkb、Csp、Prm、または App が指定されていると、指定された値が使用されます。
- AllChannels が指定されていると、指定された値が App に置き換えられます。
戻り値
型: void
setDataCategories(dataCategoryFilters)
指定されたデータカテゴリの記事が表示されるように検索条件を追加して提案結果を絞り込みます。1 回のコールに複数のデータカテゴリグループと名前のペアを設定するには、このメソッドを��用します。この検索条件は省略可能です。
署名
public void setDataCategories(Map dataCategoryFilters)
パラメーター
- dataCategoryFilters
- 型: Map
- データカテゴリグループとデータカテゴリの名前のペアの対応付け。
戻り値
型: void
setLanguage(localeCode)
特定の言語の記事が表示されるように言語を設定して提案結果を絞り込みます。この検索条件値は、System.Search.suggest(String, String, Search.SuggestionOption) へのコールでは必須です。
署名
public void setLanguage(String localeCode)
パラメーター
- localeCode
- 型: String
- ロケールコード。たとえば、'en_US' (英語 – 米国)、または 'es' (スペイン語) などです。
戻り値
型: void
setPublishStatus(publishStatus)
特定の公開状況の記事が表示されるように、その状況を設定して提案結果を絞り込みます。この検索条件値は、System.Search.suggest(String, String, Search.SuggestionOption) へのコールでは必須です。
署名
public void setPublishStatus(String publishStatus)
パラメーター
- publishStatus
- 型: String
- 公開状況。有効な値は、次のとおりです。
- Draft – Salesforce ナレッジに公開されていない記事。
- Online – Salesforce ナレッジに公開されている記事。
- Archived – [アーカイブ済み記事] ビューで参照可能な公開されていない記事。
setValidationStatus(validationStatus)
署名
public void setValidationStatus(String validationStatus)
パラメーター
- validationStatus
- 型: String
- 記事の検証状況。これらの値は、KnowledgeArticleVersion オブジェクトの ValidationStatus 項目で使用できます。
戻り値
型: void