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

accessToken

axiosInstance

basePath

clientInfo

deviceInfo

authorizationHeader

• get authorizationHeader(): string

• Returns string

configuration

• get configuration(): Configuration

• Returns Configuration

authenticateUserByName

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

• Convenience method for authenticating a user by name and updating the internal state.

  Parameters

  • username: string

    The username.
  • Optionalpassword: string

    The user password if required.

  Returns Promise<AxiosResponse<AuthenticationResult>>

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> | AxiosResponse<never>>

• Convenience method for logging out and updating the internal state.

  Returns Promise<AxiosResponse<void> | AxiosResponse<never>>