Class UserLibraryApi

UserLibraryApi - object-oriented interface

Export

UserLibraryApi

Hierarchy

BaseAPI
- UserLibraryApi

Index

Constructors

constructor

new UserLibraryApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): UserLibraryApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns UserLibraryApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

deleteUserItemRating

deleteUserItemRating(
requestParameters: UserLibraryApiDeleteUserItemRatingRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserItemDataDto>>
Parameters
- requestParameters: UserLibraryApiDeleteUserItemRatingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1068

getIntros

getIntros(
requestParameters: UserLibraryApiGetIntrosRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: UserLibraryApiGetIntrosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1080

getItem

getItem(
requestParameters: UserLibraryApiGetItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto>>
Parameters
- requestParameters: UserLibraryApiGetItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1092

getLatestMedia

getLatestMedia(
requestParameters?: UserLibraryApiGetLatestMediaRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto[]>>
Parameters
- requestParameters: UserLibraryApiGetLatestMediaRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto[]>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1104

getLocalTrailers

getLocalTrailers(
requestParameters: UserLibraryApiGetLocalTrailersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto[]>>
Parameters
- requestParameters: UserLibraryApiGetLocalTrailersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto[]>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1116

getRootFolder

getRootFolder(
requestParameters?: UserLibraryApiGetRootFolderRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto>>
Parameters
- requestParameters: UserLibraryApiGetRootFolderRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1128

getSpecialFeatures

getSpecialFeatures(
requestParameters: UserLibraryApiGetSpecialFeaturesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto[]>>
Parameters
- requestParameters: UserLibraryApiGetSpecialFeaturesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto[]>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1140

markFavoriteItem

markFavoriteItem(
requestParameters: UserLibraryApiMarkFavoriteItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserItemDataDto>>
Parameters
- requestParameters: UserLibraryApiMarkFavoriteItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1152

unmarkFavoriteItem

unmarkFavoriteItem(
requestParameters: UserLibraryApiUnmarkFavoriteItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserItemDataDto>>
Parameters
- requestParameters: UserLibraryApiUnmarkFavoriteItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1164

updateUserItemRating

updateUserItemRating(
requestParameters: UserLibraryApiUpdateUserItemRatingRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserItemDataDto>>
Parameters
- requestParameters: UserLibraryApiUpdateUserItemRatingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto>>
Throws
Memberof
UserLibraryApi
- Defined in generated-client/api/user-library-api.ts:1176

Class UserLibraryApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserLibraryApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

deleteUserItemRating

Parameters

Returns Promise<AxiosResponse<UserItemDataDto>>

Throws

Memberof

getIntros

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>

Throws

Memberof

getItem

Parameters

Returns Promise<AxiosResponse<BaseItemDto>>

Throws

Memberof

getLatestMedia

Parameters

Returns Promise<AxiosResponse<BaseItemDto[]>>

Throws

Memberof

getLocalTrailers

Parameters

Returns Promise<AxiosResponse<BaseItemDto[]>>

Throws

Memberof

getRootFolder

Parameters

Returns Promise<AxiosResponse<BaseItemDto>>

Throws

Memberof

getSpecialFeatures

Parameters

Returns Promise<AxiosResponse<BaseItemDto[]>>

Throws

Memberof

markFavoriteItem

Parameters

Returns Promise<AxiosResponse<UserItemDataDto>>

Throws

Memberof

unmarkFavoriteItem

Parameters

Returns Promise<AxiosResponse<UserItemDataDto>>

Throws

Memberof

updateUserItemRating

Parameters

Returns Promise<AxiosResponse<UserItemDataDto>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration