@jellyfin/sdk
    Preparing search index...

    Function CollectionApiFp

    • CollectionApi - functional programming interface

      Parameters

      Returns {
          addToCollection(
              collectionId: string,
              ids: string[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
          createCollection(
              name?: string,
              ids?: string[],
              parentId?: string,
              isLocked?: boolean,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<CollectionCreationResult>,
          >;
          removeFromCollection(
              collectionId: string,
              ids: string[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
      }

      • addToCollection: function
        • Parameters

          • collectionId: string

            The collection id.

          • ids: string[]

            Item ids, comma delimited.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • createCollection: function
        • Parameters

          • Optionalname: string

            The name of the collection.

          • Optionalids: string[]

            Item Ids to add to the collection.

          • OptionalparentId: string

            Optional. Create the collection within a specific folder.

          • OptionalisLocked: boolean

            Whether or not to lock the new collection.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • removeFromCollection: function
        • Parameters

          • collectionId: string

            The collection id.

          • ids: string[]

            Item ids, comma delimited.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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