Function UserViewsApiAxiosParamCreator

UserViewsApi - axios parameter creator

Export

UserViewsApiAxiosParamCreator(configuration?): {
getGroupingOptions: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
getUserViews: ((userId?: string, includeExternalContent?: boolean, presetViews?: CollectionType[], includeHidden?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}
Parameters
- Optionalconfiguration: Configuration
Returns {
getGroupingOptions: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
getUserViews: ((userId?: string, includeExternalContent?: boolean, presetViews?: CollectionType[], includeHidden?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}
- getGroupingOptions: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)
  Summary
  Get user view grouping options.
  
  Throws
  - - (userId?, options?): Promise<RequestArgs>
    - Parameters
      OptionaluserId: string
      User id.
      
      Optionaloptions: RawAxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- getUserViews: ((userId?: string, includeExternalContent?: boolean, presetViews?: CollectionType[], includeHidden?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)
  Summary
  Get user views.
  
  Throws
  - - (userId?, includeExternalContent?, presetViews?, includeHidden?, options?): Promise<RequestArgs>
    - Parameters
      OptionaluserId: string
      User id.
      
      OptionalincludeExternalContent: boolean
      Whether or not to include external views such as channels or live tv.
      
      OptionalpresetViews: CollectionType[]
      Preset views.
      
      OptionalincludeHidden: boolean
      Whether or not to include hidden content.
      
      Optionaloptions: RawAxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- Defined in generated-client/api/user-views-api.ts:35

Function UserViewsApiAxiosParamCreator

Export

Parameters

Returns { getGroupingOptions: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>); getUserViews: ((userId?: string, includeExternalContent?: boolean, presetViews?: CollectionType[], includeHidden?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>); }

getGroupingOptions: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

getUserViews: ((userId?: string, includeExternalContent?: boolean, presetViews?: CollectionType[], includeHidden?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

Settings

Returns {
getGroupingOptions: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
getUserViews: ((userId?: string, includeExternalContent?: boolean, presetViews?: CollectionType[], includeHidden?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}