Apex 開発者ガイド
jZones クラス
名前空間
Zones のメソッド
getZone(communityId, zoneId)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Zone getZone(String communityId, String zoneId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- zoneId
- 型: String
- ゾーンの ID。
戻り値
getZones(communityId)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ZonePage getZones(String communityId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
戻り値
getZones(communityId, pageParam, pageSize)
API バージョン
29.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Zone getZones(String communityId, Integer pageParam, Integer pageSize)
パラメーター
戻り値
searchInZone(communityId, zoneId, q, filter)
API バージョン
29.0
ゲストユーザーが使用可能
37.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ZoneSearchPage searchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- zoneId
- 型: String
- ゾーンの ID。
- q
- 型: String
- 検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.ZoneSearchResultType
-
ZoneSearchResultType 列挙値。次のいずれかになります。
- Article — 検索結果には記事のみが含まれます。
- Question — 検索結果には質問のみが含まれます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchInZone(communityId, zoneId, q, filter, pageParam, pageSize)
API バージョン
29.0
ゲストユーザーが使用可能
37.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ZoneSearchPage searchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, String pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- zoneId
- 型: String
- ゾーンの ID。
- q
- 型: String
- 検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.ZoneSearchResultType
-
ZoneSearchResultType 列挙値。次のいずれかになります。
- Article — 検索結果には記事のみが含まれます。
- Question — 検索結果には質問のみが含まれます。
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchInZone(communityId, zoneId, q, filter, language)
API バージョン
36.0
ゲストユーザーが使用可能
37.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ZoneSearchPage searchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, String language)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- zoneId
- 型: String
- ゾーンの ID。
- q
- 型: String
- 検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.ZoneSearchResultType
-
- Article — 検索結果には記事のみが含まれます。
- Question — 検索結果には質問のみが含まれます。
- language
- 型: String
- 記事または質問の言語。値は、Salesforce でサポートされるロケールコードである必要があります。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
Zones テストメソッド
これらのメソッドを使用して ConnectApi コードをテストする方法の詳細は、「ConnectApi コードのテスト」を参照してください。
setTestSearchInZone(communityId, zoneId, q, filter, result)
API バージョン
29.0
署名
public static Void setTestSearchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, ConnectApi.ZoneSearchPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null のいずれかを使用します。
- zoneId
- 型: String
- ゾーンの ID。
- q
- 型: String
- 検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.ZoneSearchResultType
-
ZoneSearchResultType 列挙値。次のいずれかになります。
- Article — 検索結果には記事のみが含まれます。
- Question — 検索結果には質問のみが含まれます。
- result
- 型: ConnectApi.ZoneSearchPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchInZone(communityId, zoneId, q, filter, pageParam, pageSize, result)
API バージョン
29.0
署名
public static Void setTestSearchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, String pageParam, Integer pageSize, ConnectApi.ZoneSearchPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null のいずれかを使用します。
- zoneId
- 型: String
- ゾーンの ID。
- q
- 型: String
- 検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.ZoneSearchResultType
-
ZoneSearchResultType 列挙値。次のいずれかになります。
- Article — 検索結果には記事のみが含まれます。
- Question — 検索結果には質問のみが含まれます。
- pageParam
- 型: String
- 情報ページの表示に使用されるページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- result
- 型: ConnectApi.ZoneSearchPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchInZone(communityId, zoneId, q, filter, language, result)
API バージョン
36.0
署名
public static Void setTestSearchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, String language, ConnectApi.ZoneSearchPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null のいずれかを使用します。
- zoneId
- 型: String
- ゾーンの ID。
- q
- 型: String
- 検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.ZoneSearchResultType
-
- Article — 検索結果には記事のみが含まれます。
- Question — 検索結果には質問のみが含まれます。
- language
- 型: String
- 記事または質問の言語。値は、Salesforce でサポートされるロケールコードである必要があります。<apex:page> のデフォルト値は、ページの言語です。それ以外のデフォルト値は、ユーザーのロケールです。
- result
- 型: ConnectApi.ZoneSearchPage
- テストデータを含むオブジェクト。
戻り値
型: Void