API Docs for: 2.0.20133.2
Show:

api.suggest Class

Defined in: src\internal\api\suggest\suggestApi.ts:19
Module: API Suggest
Parent Module: API

Suggest API to get suggestion results for support

Item Index

Methods

Methods

formSuggestUrl

(
  • config
)
private static

Defined in src\internal\api\suggest\suggestApi.ts:104

Forms the suggest endpoint with necessary suggest parameters

Parameters:

  • config SuggestConfig

getSuggestResults

(
  • config
)
Promise | SuggestResultSet static

Defined in src\internal\api\suggest\suggestApi.ts:25

Gets suggestion results for the scopes, language specified

Parameters:

  • config Object

    A config object to enlist the input criteria.

    • query. String

      Suggest query.

    • locale. String

      Comma delimited locale for suggest results.

    • count. Number

      Total number of suggest results to be returned.

    • tenant. String

      Specify tenant to be used.

    • version. String

      Targeting a specific version.

Returns:

Promise | SuggestResultSet:

. Promise of suggest results.