Function ArtistsApiFp

ArtistsApi - functional programming interface

Export

  • ArtistsApiFp(configuration?): {
        getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: BaseItemKind[], includeItemTypes?: BaseItemKind[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: MediaType[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], enableImages?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
        getArtistByName(name: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>;
        getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: BaseItemKind[], includeItemTypes?: BaseItemKind[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: MediaType[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], enableImages?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    }

  • Parameters

    Returns {
        getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: BaseItemKind[], includeItemTypes?: BaseItemKind[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: MediaType[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], enableImages?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
        getArtistByName(name: string, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>;
        getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: BaseItemKind[], includeItemTypes?: BaseItemKind[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: MediaType[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], enableImages?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    }

    • getAlbumArtists:function
      • getAlbumArtists(minCommunityRating?, startIndex?, limit?, searchTerm?, parentId?, fields?, excludeItemTypes?, includeItemTypes?, filters?, isFavorite?, mediaTypes?, genres?, genreIds?, officialRatings?, tags?, years?, enableUserData?, imageTypeLimit?, enableImageTypes?, person?, personIds?, personTypes?, studios?, studioIds?, userId?, nameStartsWithOrGreater?, nameStartsWith?, nameLessThan?, sortBy?, sortOrder?, enableImages?, enableTotalRecordCount?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

      • Parameters

        • OptionalminCommunityRating: number

          Optional filter by minimum community rating.

        • 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

          Optional. 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 based on item type. This allows multiple, comma delimited.

        • Optionalfilters: ItemFilter[]

          Optional. Specify additional filters to apply.

        • OptionalisFavorite: boolean

          Optional filter by items that are marked as favorite, or not.

        • OptionalmediaTypes: MediaType[]

          Optional filter by MediaType. Allows multiple, comma delimited.

        • Optionalgenres: string[]

          Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

        • OptionalgenreIds: string[]

          Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

        • OptionalofficialRatings: string[]

          Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

        • Optionaltags: string[]

          Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.

        • Optionalyears: number[]

          Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.

        • OptionalenableUserData: boolean

          Optional, include user data.

        • OptionalimageTypeLimit: number

          Optional, the max number of images to return, per image type.

        • OptionalenableImageTypes: ImageType[]

          Optional. The image types to include in the output.

        • Optionalperson: string

          Optional. If specified, results will be filtered to include only those containing the specified person.

        • OptionalpersonIds: string[]

          Optional. If specified, results will be filtered to include only those containing the specified person ids.

        • OptionalpersonTypes: string[]

          Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.

        • Optionalstudios: string[]

          Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.

        • OptionalstudioIds: string[]

          Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.

        • 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

          Total record count.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

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

        Throws

    • getArtistByName:function
      • getArtistByName(name, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>)>

      • Parameters

        • name: string

          Studio name.

        • OptionaluserId: string

          Optional. Filter by user id, and attach user data.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Gets an artist by name.

        Throws

    • getArtists:function
      • getArtists(minCommunityRating?, startIndex?, limit?, searchTerm?, parentId?, fields?, excludeItemTypes?, includeItemTypes?, filters?, isFavorite?, mediaTypes?, genres?, genreIds?, officialRatings?, tags?, years?, enableUserData?, imageTypeLimit?, enableImageTypes?, person?, personIds?, personTypes?, studios?, studioIds?, userId?, nameStartsWithOrGreater?, nameStartsWith?, nameLessThan?, sortBy?, sortOrder?, enableImages?, enableTotalRecordCount?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

      • Parameters

        • OptionalminCommunityRating: number

          Optional filter by minimum community rating.

        • 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

          Optional. 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 based on item type. This allows multiple, comma delimited.

        • Optionalfilters: ItemFilter[]

          Optional. Specify additional filters to apply.

        • OptionalisFavorite: boolean

          Optional filter by items that are marked as favorite, or not.

        • OptionalmediaTypes: MediaType[]

          Optional filter by MediaType. Allows multiple, comma delimited.

        • Optionalgenres: string[]

          Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

        • OptionalgenreIds: string[]

          Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

        • OptionalofficialRatings: string[]

          Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

        • Optionaltags: string[]

          Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.

        • Optionalyears: number[]

          Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.

        • OptionalenableUserData: boolean

          Optional, include user data.

        • OptionalimageTypeLimit: number

          Optional, the max number of images to return, per image type.

        • OptionalenableImageTypes: ImageType[]

          Optional. The image types to include in the output.

        • Optionalperson: string

          Optional. If specified, results will be filtered to include only those containing the specified person.

        • OptionalpersonIds: string[]

          Optional. If specified, results will be filtered to include only those containing the specified person ids.

        • OptionalpersonTypes: string[]

          Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.

        • Optionalstudios: string[]

          Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.

        • OptionalstudioIds: string[]

          Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.

        • 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

          Total record count.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

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

        Throws

Settings

Member Visibility