Documentation build (#6762)

* move doc dependency in doctools * add ignore link * rebuild doc * version index * put it back some deps
2025-07-24 17:32:15 +00:00 · 2021-03-03 14:08:15 +00:00
parent e05c80f04f
commit c3452a4f62
227 changed files with 6994 additions and 4146 deletions
--- a/docs/content-services/services/search-query-builder.service.md
+++ b/docs/content-services/services/search-query-builder.service.md
@@ -13,91 +13,78 @@ Stores information from all the custom search and faceted search widgets, compil

 ### Methods

-*   **addFilterQuery**(query: `string`)<br/>
+-   **addFilterQuery**(query: `string`)<br/>
    Adds a filter query to the current query.
-    *   *query:* `string`  - Query string to add
-
-*   **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
+    -   _query:_ `string`  - Query string to add
+-   **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
    Adds a facet bucket to a field.
-    *   *field:* [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)  - The target field
-    *   *bucket:* [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)  - Bucket to add
-
-*   **buildQuery**(): `QueryBody`<br/>
+    -   _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)  - The target field
+    -   _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)  - Bucket to add
+-   **buildQuery**(): `QueryBody`<br/>
    Builds the current query.
-    *   **Returns** `QueryBody` - The finished query
-
-*   **execute**(queryBody?: `QueryBody`)<br/>
+    -   **Returns** `QueryBody` - The finished query
+-   **execute**(queryBody?: `QueryBody`)<br/>
    Builds and executes the current query.
-    *   *queryBody:* `QueryBody`  - (Optional)
-
-*   **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)<br/>
+    -   _queryBody:_ `QueryBody`  - (Optional) (Optional)
+-   **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)<br/>
    Gets a facet field by label.
-    *   *label:* `string`  - Label of the facet field
-    *   **Returns** [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - Facet field data
-
-*   **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts)<br/>
+    -   _label:_ `string`  - Label of the facet field
+    -   **Returns** [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - Facet field data
+-   **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts)<br/>
    Gets a facet query by label.
-    *   *label:* `string`  - Label of the query
-    *   **Returns** [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts) - Facet query data
-
-*   **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)<br/>
+    -   _label:_ `string`  - Label of the query
+    -   **Returns** [`FacetQuery`](../../../lib/content-services/src/lib/search/facet-query.interface.ts) - Facet query data
+-   **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)<br/>
    Gets the primary sorting definition.
-    *   **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts) - The primary sorting definition
-
-*   **getQueryGroup**(query: `any`): `any`<br/>
+    -   **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts) - The primary sorting definition
+-   **getQueryGroup**(query: `any`): `any`<br/>
    Gets the query group.
-    *   *query:* `any`  - Target query
-    *   **Returns** `any` - Query group
+    -   _query:_ `any`  - Target query
+    -   **Returns** `any` - Query group
+-   **getScope**(): [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts)<br/>

-*   **getScope**(): [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts)<br/>
+    -   **Returns** [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts) - 

-    *   **Returns** [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts) -
-
-*   **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]`<br/>
+-   **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]`<br/>
    Gets all pre-configured sorting options that users can choose from.
-    *   **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
-
-*   **getSupportedLabel**(configLabel: `string`): `string`<br/>
+    -   **Returns** [`SearchSortingDefinition`](../../../lib/content-services/src/lib/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
+-   **getSupportedLabel**(configLabel: `string`): `string`<br/>
    Encloses a label name with double quotes if it contains whitespace characters.
-    *   *configLabel:* `string`  - Original label text
-    *   **Returns** `string` - Label, possibly with quotes if it contains spaces
-
-*   **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]`<br/>
+    -   _configLabel:_ `string`  - Original label text
+    -   **Returns** `string` - Label, possibly with quotes if it contains spaces
+-   **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]`<br/>
    Gets the buckets currently added to a field
-    *   *field:* `string`  - The target fields
-    *   **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array
+    -   _field:_ `string`  - The target fields
+    -   **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array
+-   **isFilterServiceActive**(): `boolean`<br/>

-*   **isFilterServiceActive**(): `boolean`<br/>
+    -   **Returns** `boolean` - 

-    *   **Returns** `boolean` -
+-   **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)<br/>

-*   **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)<br/>
+    -   **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) - 

-    *   **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) -
-
-*   **removeFilterQuery**(query: `string`)<br/>
+-   **removeFilterQuery**(query: `string`)<br/>
    Removes an existing filter query.
-    *   *query:* `string`  - The query to remove
-
-*   **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
+    -   _query:_ `string`  - The query to remove
+-   **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts))<br/>
    Removes an existing bucket from a field.
-    *   *field:* [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)  - The target field
-    *   *bucket:* [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)  - Bucket to remove
+    -   _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts)  - The target field
+    -   _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)  - Bucket to remove
+-   **resetToDefaults**()<br/>

-*   **resetToDefaults**()<br/>
+-   **search**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`<br/>

-*   **search**(queryBody: `QueryBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>`<br/>
+    -   _queryBody:_ `QueryBody`  - 
+    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` - 

-    *   *queryBody:* `QueryBody`  -
-    *   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ResultSetPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/search-rest-api/docs/ResultSetPaging.md)`>` -
+-   **setScope**(scope: [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts))<br/>

-*   **setScope**(scope: [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts))<br/>
+    -   _scope:_ [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts)  - 

-    *   *scope:* [`RequestScope`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/search-rest-api/model/requestScope.ts)  -
-
-*   **update**(queryBody?: `QueryBody`)<br/>
+-   **update**(queryBody?: `QueryBody`)<br/>
    Builds the current query and triggers the `updated` event.
-    *   *queryBody:* `QueryBody`  - (Optional)
+    -   _queryBody:_ `QueryBody`  - (Optional) (Optional)

 ## Details

@@ -109,13 +96,13 @@ You can reuse it with multiple component implementations.

 You can use custom widgets to populate and edit the following parts of the resulting query:

-*   categories
-*   query fragments that form a query expression
-*   include fields
-*   scope settings
-*   filter queries
-*   facet fields
-*   range queries
+-   categories
+-   query fragments that form a query expression
+-   include fields
+-   scope settings
+-   filter queries
+-   facet fields
+-   range queries

 ```ts
 constructor(queryBuilder: SearchQueryBuilderService) {
@@ -135,5 +122,5 @@ constructor(queryBuilder: SearchQueryBuilderService) {

 ## See also

-*   [Search filter component](../components/search-filter.component.md)
-*   [Search Widget interface](../interfaces/search-widget.interface.md)
+-   [Search filter component](../components/search-filter.component.md)
+-   [Search Widget interface](../interfaces/search-widget.interface.md)