クラス: Builder

gapi.cloudsearch.widget.resultscontainer.Builder

クラス   静的

結果コンテナ ビルダー。ビルダーを使用し、コンテナのコンストラクタを直接呼び出さないでください。

コンストラクタ

Builder

new 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 this

setFacetResultsContainerElement

setFacetResultsContainerElement(facetResultsContainerElement) は Builder を返します。

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

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

戻り値

non-null Builder this

setIncludePagination

setIncludePagination(includePagination) returns Builder

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

パラメータ
includePagination	ブール値

戻り値

non-null Builder this

setResultsContainer

setResultsContainer(resultsContainer) は Builder を返します。

必須。コンテナの要素を設定します。子ノードを含めることができる有効な要素である必要があります。

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

非推奨

戻り値

non-null Builder this

setSearchApplicationId

setSearchApplicationId(searchApplicationId) returns Builder

（省略可）リクエストに使用する検索アプリ ID を設定します。先頭に「searchapplications/」を付ける必要があります。

パラメータ
searchApplicationId	文字列

戻り値

non-null Builder this

setSearchResultsContainerElement

setSearchResultsContainerElement(searchResultsContainerElement) returns Builder

必須。コンテナの要素を設定します。子ノードを含めることができる有効な要素である必要があります。

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

戻り値

non-null Builder this