クラス: Builder

gapi.cloudsearch.widget.resultscontainer.Builder

クラス   静的

結果コンテナ ビルダー。ビルダーを使用し、直接呼び出しは行わない あります。

コンストラクタ

Builder

新着 Builder()

例

// Builds a results container.
function onload() {
  gapi.client.init({
    'apiKey': '<your api key>',
    'clientId': '<your client id>',
    // Add additional scopes if needed
    'scope': 'https://www.googleapis.com/auth/cloud_search.query',
    'hosted_domain': '<your G Suite domain>',
  });

  const resultscontainer =
      new gapi.cloudsearch.widget.resultscontainer.Builder()
        .setSearchResultsContainerElement(document.getElementById('search_result'))
        .build();

  const searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
    .setInput(document.getElementById('input'))
    .setAnchor(document.getElementById('input').parentElement)
    .setResultsContainer(resultscontainer);
    .build();
}
gapi.load('client:cloudsearch-widget', onload);

メソッド

build

build() が ResultsContainer を返す

結果コンテナをビルドします。

戻り値

non-null ResultsContainer 

setAdapter

setAdapter(adapter) が Builder を返す

（省略可）ユーザー エクスペリエンスをカスタマイズするアダプターを設定します。

パラメータ
アダプター	ResultsContainerAdapter 値を null にすることはできません。

戻り値

non-null Builder これ

setFacetResultsContainerElement

setFacetResultsContainerElement(facetResultsContainerElement) はビルダーを返します。

ファセット結果のコンテナ要素を設定します。 子ノードを含めることができる有効な要素を指定してください。

パラメータ
facetResultsContainerElement	要素 値を null にすることはできません。

戻り値

non-null Builder これ

setIncludePagination

setIncludePagination(includePagination) はビルダーを返します。

（省略可）デフォルトは true です。 true に設定した場合、結果コンテナにデフォルトのページ分割 UI が含まれます。

パラメータ
includePagination	ブール値

戻り値

non-null Builder これ

setResultsContainer

setResultsContainer(resultsContainer) はビルダーを返します。

必須。コンテナの要素を設定します。 子ノードを含めることができる有効な要素を指定してください。

パラメータ
resultsContainer	要素 値を null にすることはできません。

非推奨

戻り値

non-null Builder これ

setSearchApplicationId

setSearchApplicationId(searchApplicationId) は Builder を返します

（省略可）リクエストに使用する検索アプリケーション ID を設定します。必須 先頭に「searchapplications/」が付きます。

パラメータ
searchApplicationId	文字列

戻り値

non-null Builder これ

setSearchResultsContainerElement

setSearchResultsContainerElement(searchResultsContainerElement) はビルダーを返します。

必須。コンテナの要素を設定します。 子ノードを含めることができる有効な要素を指定してください。

パラメータ
searchResultsContainerElement	要素 値を null にすることはできません。

戻り値

non-null Builder これ