Function GenresApiAxiosParamCreator

Returns {
    getGenre: ((genreName: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getGenres: ((startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: BaseItemKind[], includeItemTypes?: BaseItemKind[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], enableImages?: boolean, enableTotalRecordCount?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• getGenre: ((genreName: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a genre, by name.

  Throws

  • • (genreName, userId?, options?): Promise<RequestArgs>

    • Parameters

      • genreName: string

        The genre name.
      • OptionaluserId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getGenres: ((startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: BaseItemKind[], includeItemTypes?: BaseItemKind[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], enableImages?: boolean, enableTotalRecordCount?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets all genres from a given item, folder, or the entire library.

  Throws

  • • (startIndex?, limit?, searchTerm?, parentId?, fields?, excludeItemTypes?, includeItemTypes?, isFavorite?, imageTypeLimit?, enableImageTypes?, userId?, nameStartsWithOrGreater?, nameStartsWith?, nameLessThan?, sortBy?, sortOrder?, enableImages?, enableTotalRecordCount?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalstartIndex: number

        Optional. The record index to start at. All items with a lower index will be dropped from the results.
      • Optionallimit: number

        Optional. The maximum number of records to return.
      • OptionalsearchTerm: string

        The search term.
      • OptionalparentId: string

        Specify this to localize the search to a specific item or folder. Omit to use the root.
      • Optionalfields: ItemFields[]

        Optional. Specify additional fields of information to return in the output.
      • OptionalexcludeItemTypes: BaseItemKind[]

        Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
      • OptionalincludeItemTypes: BaseItemKind[]

        Optional. If specified, results will be filtered in based on item type. This allows multiple, comma delimited.
      • OptionalisFavorite: boolean

        Optional filter by items that are marked as favorite, or not.
      • OptionalimageTypeLimit: number

        Optional, the max number of images to return, per image type.
      • OptionalenableImageTypes: ImageType[]

        Optional. The image types to include in the output.
      • OptionaluserId: string

        User id.
      • OptionalnameStartsWithOrGreater: string

        Optional filter by items whose name is sorted equally or greater than a given input string.
      • OptionalnameStartsWith: string

        Optional filter by items whose name is sorted equally than a given input string.
      • OptionalnameLessThan: string

        Optional filter by items whose name is equally or lesser than a given input string.
      • OptionalsortBy: ItemSortBy[]

        Optional. Specify one or more sort orders, comma delimited.
      • OptionalsortOrder: SortOrder[]

        Sort Order - Ascending,Descending.
      • OptionalenableImages: boolean

        Optional, include image information in output.
      • OptionalenableTotalRecordCount: boolean

        Optional. Include total record count.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>