クラス: Builder

gapi.cloudsearch.widget.resultscontainer.Builder

class static

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

コンストラクタ

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);

Methods

構築する

build() が ResultsContainer を返す

結果コンテナを構築します。

戻り値

non-null ResultsContainer 

setAdapter

setAdapter(adapter) が Builder を返す

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

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

戻り値

non-null Builder 件

setFacetResultsContainerElement

setFacetResultsContainerElement(facetResultsContainerElement) が Builder を返す

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

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

戻り値

non-null Builder 件

setIncludePagination

setIncludePagination(includePagination) は、Builder を返します。

省略可。デフォルトは true です。 true に設定すると、結果コンテナにデフォルトのページ設定 UI が含まれます。

パラメータ
includePagination	boolean

戻り値

non-null Builder 件

setResultsContainer

setResultsContainer(resultsContainer) は Builder を返す

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

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

非推奨

戻り値

non-null Builder 件

setSearchApplicationId

setSearchApplicationId(searchApplicationId) が Builder を返す

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

パラメータ
searchApplicationId	string

戻り値

non-null Builder 件

setSearchResultsContainerElement

setSearchResultsContainerElement(searchResultsContainerElement) は、Builder を返します。

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

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

戻り値

non-null Builder 件