-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
395 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) > [(constructor)](./search-core.endpointsprovider._constructor_.md) | ||
|
||
## EndpointsProvider.(constructor) | ||
|
||
Constructs a new instance of the `EndpointsProvider` class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
constructor(environment?: Environment, cloudRegion?: CloudRegion, overrideEndpoints?: Endpoints); | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| environment | Environment | | | ||
| cloudRegion | CloudRegion | | | ||
| overrideEndpoints | [Endpoints](./search-core.endpoints.md) | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) > [getEndpoints](./search-core.endpointsprovider.getendpoints.md) | ||
|
||
## EndpointsProvider.getEndpoints() method | ||
|
||
Provides all endpoints based on environment and cloud region. Include any custom overrides in overrideEndpoints. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getEndpoints(): { | ||
universalSearch: string; | ||
verticalSearch: string; | ||
questionSubmission: string; | ||
status: string; | ||
universalAutocomplete: string; | ||
verticalAutocomplete: string; | ||
filterSearch: string; | ||
}; | ||
``` | ||
<b>Returns:</b> | ||
|
||
{ universalSearch: string; verticalSearch: string; questionSubmission: string; status: string; universalAutocomplete: string; verticalAutocomplete: string; filterSearch: string; } | ||
|
||
## Remarks | ||
|
||
Returns an [Endpoints](./search-core.endpoints.md) instance. | ||
|
17 changes: 17 additions & 0 deletions
17
docs/search-core.endpointsprovider.getfiltersearchendpoint.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) > [getFilterSearchEndpoint](./search-core.endpointsprovider.getfiltersearchendpoint.md) | ||
|
||
## EndpointsProvider.getFilterSearchEndpoint() method | ||
|
||
Returns the endpoint for filter search. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getFilterSearchEndpoint(): string; | ||
``` | ||
<b>Returns:</b> | ||
|
||
string | ||
|
17 changes: 17 additions & 0 deletions
17
docs/search-core.endpointsprovider.getquestionsubmissionendpoint.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) > [getQuestionSubmissionEndpoint](./search-core.endpointsprovider.getquestionsubmissionendpoint.md) | ||
|
||
## EndpointsProvider.getQuestionSubmissionEndpoint() method | ||
|
||
Returns the endpoint for question submission. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getQuestionSubmissionEndpoint(): string; | ||
``` | ||
<b>Returns:</b> | ||
|
||
string | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) > [getStatusEndpoint](./search-core.endpointsprovider.getstatusendpoint.md) | ||
|
||
## EndpointsProvider.getStatusEndpoint() method | ||
|
||
Returns the endpoint for status. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getStatusEndpoint(): string; | ||
``` | ||
<b>Returns:</b> | ||
|
||
string | ||
|
17 changes: 17 additions & 0 deletions
17
docs/search-core.endpointsprovider.getuniversalautocomplete.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) > [getUniversalAutocomplete](./search-core.endpointsprovider.getuniversalautocomplete.md) | ||
|
||
## EndpointsProvider.getUniversalAutocomplete() method | ||
|
||
Returns the endpoint for universal autocomplete. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getUniversalAutocomplete(): string; | ||
``` | ||
<b>Returns:</b> | ||
|
||
string | ||
|
17 changes: 17 additions & 0 deletions
17
docs/search-core.endpointsprovider.getuniversalsearchendpoint.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) > [getUniversalSearchEndpoint](./search-core.endpointsprovider.getuniversalsearchendpoint.md) | ||
|
||
## EndpointsProvider.getUniversalSearchEndpoint() method | ||
|
||
Returns the endpoint for universal search. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getUniversalSearchEndpoint(): string; | ||
``` | ||
<b>Returns:</b> | ||
|
||
string | ||
|
17 changes: 17 additions & 0 deletions
17
docs/search-core.endpointsprovider.getverticalautocomplete.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) > [getVerticalAutocomplete](./search-core.endpointsprovider.getverticalautocomplete.md) | ||
|
||
## EndpointsProvider.getVerticalAutocomplete() method | ||
|
||
Returns the endpoint for vertical autocomplete. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getVerticalAutocomplete(): string; | ||
``` | ||
<b>Returns:</b> | ||
|
||
string | ||
|
17 changes: 17 additions & 0 deletions
17
docs/search-core.endpointsprovider.getverticalsearchendpoint.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) > [getVerticalSearchEndpoint](./search-core.endpointsprovider.getverticalsearchendpoint.md) | ||
|
||
## EndpointsProvider.getVerticalSearchEndpoint() method | ||
|
||
Returns the endpoint for vertical search. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getVerticalSearchEndpoint(): string; | ||
``` | ||
<b>Returns:</b> | ||
|
||
string | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [EndpointsProvider](./search-core.endpointsprovider.md) | ||
|
||
## EndpointsProvider class | ||
|
||
Provides methods for getting various endpoints. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare class EndpointsProvider | ||
``` | ||
|
||
## Constructors | ||
|
||
| Constructor | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [(constructor)(environment, cloudRegion, overrideEndpoints)](./search-core.endpointsprovider._constructor_.md) | | Constructs a new instance of the <code>EndpointsProvider</code> class | | ||
|
||
## Methods | ||
|
||
| Method | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [getEndpoints()](./search-core.endpointsprovider.getendpoints.md) | | Provides all endpoints based on environment and cloud region. Include any custom overrides in overrideEndpoints. | | ||
| [getFilterSearchEndpoint()](./search-core.endpointsprovider.getfiltersearchendpoint.md) | | Returns the endpoint for filter search. | | ||
| [getQuestionSubmissionEndpoint()](./search-core.endpointsprovider.getquestionsubmissionendpoint.md) | | Returns the endpoint for question submission. | | ||
| [getStatusEndpoint()](./search-core.endpointsprovider.getstatusendpoint.md) | | Returns the endpoint for status. | | ||
| [getUniversalAutocomplete()](./search-core.endpointsprovider.getuniversalautocomplete.md) | | Returns the endpoint for universal autocomplete. | | ||
| [getUniversalSearchEndpoint()](./search-core.endpointsprovider.getuniversalsearchendpoint.md) | | Returns the endpoint for universal search. | | ||
| [getVerticalAutocomplete()](./search-core.endpointsprovider.getverticalautocomplete.md) | | Returns the endpoint for vertical autocomplete. | | ||
| [getVerticalSearchEndpoint()](./search-core.endpointsprovider.getverticalsearchendpoint.md) | | Returns the endpoint for vertical search. | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.