Function SuggestionsApiFp

SuggestionsApi - functional programming interface

Export

SuggestionsApiFp(configuration?): {
getSuggestions(userId?: string, mediaType?: MediaType[], type?: BaseItemKind[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
}
Parameters
- Optionalconfiguration: Configuration
Returns {
getSuggestions(userId?: string, mediaType?: MediaType[], type?: BaseItemKind[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
}
- getSuggestions:function
  - getSuggestions(userId?, mediaType?, type?, startIndex?, limit?, enableTotalRecordCount?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
  - Parameters
    - OptionaluserId: string
      The user id.
    - OptionalmediaType: MediaType[]
      The media types.
    - Optionaltype: BaseItemKind[]
      The type.
    - OptionalstartIndex: number
      Optional. The start index.
    - Optionallimit: number
      Optional. The limit.
    - OptionalenableTotalRecordCount: boolean
      Whether to enable the total record count.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>
    Summary
    Gets suggestions.
    
    Throws
    - Defined in generated-client/api/suggestions-api.ts:120
- Defined in generated-client/api/suggestions-api.ts:105

Function SuggestionsApiFp

Export

Parameters

Returns { getSuggestions(userId?: string, mediaType?: MediaType[], type?: BaseItemKind[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>; }

getSuggestions:function

Parameters

Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

Summary

Throws

Settings

Returns {
getSuggestions(userId?: string, mediaType?: MediaType[], type?: BaseItemKind[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
}