類別:建構工具

建構函式

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) 傳回建構工具

(選用) 設定轉接程式來自訂使用者體驗。

參數

轉接器

ResultsContainerAdapter

值不得為空值。

傳回

non-null Builder 這個

setFacetResultsContainerElement

setFacetResultsContainerElement(facetResultsContainerElement) 傳回 Builder

設定 facet 結果的容器元素。必須是可包含子節點的有效元素。

參數

facetResultsContainerElement

元素

值不得為空值。

傳回

non-null Builder 這個

setIncludePagination

setIncludePagination(includePagination) 傳回 Builder

(選用) 預設值為 true。如果設為 true,則在結果容器中納入預設分頁 UI。

參數

includePagination

boolean

傳回

non-null Builder 這個

setResultsContainer

setResultsContainer(resultsContainer) 傳回建構工具

必備。設定容器的元素。必須是可包含子節點的有效元素。

參數

resultsContainer

元素

值不得為空值。

已淘汰
傳回

non-null Builder 這個

setSearchApplicationId

setSearchApplicationId(searchApplicationId) 傳回建構工具

(選用) 設定要在要求中使用的搜尋應用程式 ID。開頭須為「searchapplications/」。

參數

searchApplicationId

字串

傳回

non-null Builder 這個

setSearchResultsContainerElement

setSearchResultsContainerElement(searchResultsContainerElement) 傳回 Builder

必備。設定容器的元素。必須是可包含子節點的有效元素。

參數

searchResultsContainerElement

元素

值不得為空值。

傳回

non-null Builder 這個