Class Api

constructor

• new Api(
      basePath: string,
      clientInfo: ClientInfo,
      deviceInfo: DeviceInfo,
      accessToken?: string,
      axiosInstance?: AxiosInstance,
  ): Api

  Parameters

  • basePath: string
  • clientInfo: ClientInfo
  • deviceInfo: DeviceInfo
  • accessToken: string = ''
  • axiosInstance: AxiosInstance = globalInstance

  Returns Api

ReadonlyaxiosInstance

accessToken

• get accessToken(): string

  Returns string

authorizationHeader

• get authorizationHeader(): string

  Returns string

basePath

• get basePath(): string

  Returns string

clientInfo

• get clientInfo(): ClientInfo

  Returns ClientInfo

configuration

• get configuration(): Configuration

  Returns Configuration

deviceInfo

• get deviceInfo(): DeviceInfo

  Returns DeviceInfo

authenticateUserByName

• authenticateUserByName(
      username: string,
      password?: string,
  ): Promise<AxiosResponse<AuthenticationResult, any, {}>>

  Convenience method for authenticating a user by name.

  Parameters

  • username: string

    The username.

  • Optionalpassword: string

    The user password if required.

  Returns Promise<AxiosResponse<AuthenticationResult, any, {}>>

  Deprecated

  Use getUserApi().authenticateUserByName() instead.

getUri

• getUri(url: string, params?: object): string

  Gets a full URI for a relative URL to the Jellyfin server for a given SDK Api instance.

  Parameters

  • url: string

    The relative URL.

  • Optionalparams: object

    Any URL parameters.

  Returns string

  The complete URI with protocol, host, and base URL (if any).

logout

• logout(): Promise<AxiosResponse<void, any, {}> | AxiosResponse<never, any, {}>>

  Convenience method for logging out.

  Returns Promise<AxiosResponse<void, any, {}> | AxiosResponse<never, any, {}>>

  Deprecated

  Use getSessionApi().reportSessionEnded() instead.

subscribe

• subscribe<
      T extends
          | "Play"
          | "ForceKeepAlive"
          | "GeneralCommand"
          | "UserDataChanged"
          | "Sessions"
          | "SyncPlayCommand"
          | "SyncPlayGroupUpdate"
          | "Playstate"
          | "RestartRequired"
          | "ServerShuttingDown"
          | "ServerRestarting"
          | "LibraryChanged"
          | "UserDeleted"
          | "UserUpdated"
          | "SeriesTimerCreated"
          | "TimerCreated"
          | "SeriesTimerCancelled"
          | "TimerCancelled"
          | "RefreshProgress"
          | "ScheduledTaskEnded"
          | "PackageInstallationCancelled"
          | "PackageInstallationFailed"
          | "PackageInstallationCompleted"
          | "PackageInstalling"
          | "PackageUninstalled"
          | "ActivityLogEntry"
          | "ScheduledTasksInfo"
          | "KeepAlive",
  >(
      messageTypes: T[],
      onMessage: SocketMessageHandler<T>,
  ): () => void

  Type Parameters

  • T extends
        | "Play"
        | "ForceKeepAlive"
        | "GeneralCommand"
        | "UserDataChanged"
        | "Sessions"
        | "SyncPlayCommand"
        | "SyncPlayGroupUpdate"
        | "Playstate"
        | "RestartRequired"
        | "ServerShuttingDown"
        | "ServerRestarting"
        | "LibraryChanged"
        | "UserDeleted"
        | "UserUpdated"
        | "SeriesTimerCreated"
        | "TimerCreated"
        | "SeriesTimerCancelled"
        | "TimerCancelled"
        | "RefreshProgress"
        | "ScheduledTaskEnded"
        | "PackageInstallationCancelled"
        | "PackageInstallationFailed"
        | "PackageInstallationCompleted"
        | "PackageInstalling"
        | "PackageUninstalled"
        | "ActivityLogEntry"
        | "ScheduledTasksInfo"
        | "KeepAlive"

  Parameters

  • messageTypes: T[]
  • onMessage: SocketMessageHandler<T>

  Returns () => void

update

• update(
      data: Partial<
          {
              accessToken: string;
              basePath: string;
              clientInfo: ClientInfo;
              deviceInfo: DeviceInfo;
          },
      >,
  ): void

  Updates this Api instance with new data.

  If the access token is cleared, any existing WebSocket connection will be closed.

  If the base path or access token changes while a WebSocket connection is active, the connection will be reconnected with the new credentials.

  Parameters

  • data: Partial<
        {
            accessToken: string;
            basePath: string;
            clientInfo: ClientInfo;
            deviceInfo: DeviceInfo;
        },
    >

    The data to update.

  Returns void