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
(選用) 設定轉接器,以便自訂使用者體驗。
                      參數 | 
                  |
|---|---|
| 
                         adapter  | 
                      
                        
                         值不得為空值。  | 
                    
- 傳回
 - 
                  
non-null Builderthis 
setFacetResultsContainerElement
setFacetResultsContainerElement(facetResultsContainerElement) 會傳回 Builder
設定切面結果的容器元素。必須是可包含子節點的有效元素。
                      參數 | 
                  |
|---|---|
| 
                         facetResultsContainerElement  | 
                      
                         元素 值不得為空值。  | 
                    
- 傳回
 - 
                  
non-null Builderthis 
setIncludePagination
setIncludePagination(includePagination) 會傳回 Builder
(選用) 預設值為 true。 如果設為 true,就會在結果容器中加入預設的分頁 UI。
                      參數 | 
                  |
|---|---|
| 
                         includePagination  | 
                      
                         布林值  | 
                    
- 傳回
 - 
                  
non-null Builderthis 
setResultsContainer
setResultsContainer(resultsContainer) 會傳回 Builder
必填。設定容器的元素。必須是可包含子節點的有效元素。
                      參數 | 
                  |
|---|---|
| 
                         resultsContainer  | 
                      
                         元素 值不得為空值。  | 
                    
- 已淘汰
 - 傳回
 - 
                  
non-null Builderthis 
setSearchApplicationId
setSearchApplicationId(searchApplicationId) 會傳回 Builder
(選用) 設定在要求中使用的搜尋應用程式 ID。開頭必須為「searchapplications/」。
                      參數 | 
                  |
|---|---|
| 
                         searchApplicationId  | 
                      
                         字串  | 
                    
- 傳回
 - 
                  
non-null Builderthis 
setSearchResultsContainerElement
setSearchResultsContainerElement(searchResultsContainerElement) 會傳回 Builder
必填。設定容器的元素。必須是可包含子節點的有效元素。
                      參數 | 
                  |
|---|---|
| 
                         searchResultsContainerElement  | 
                      
                         元素 值不得為空值。  | 
                    
- 傳回
 - 
                  
non-null Builderthis