SessionApi - axios parameter creator

  • Parameters

    Returns {
        addUserToSession: (
            sessionId: string,
            userId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        displayContent: (
            sessionId: string,
            itemType: BaseItemKind,
            itemId: string,
            itemName: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getAuthProviders: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
        getPasswordResetProviders: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getSessions: (
            controllableByUserId?: string,
            deviceId?: string,
            activeWithinSeconds?: number,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        play: (
            sessionId: string,
            playCommand: PlayCommand,
            itemIds: string[],
            startPositionTicks?: number,
            mediaSourceId?: string,
            audioStreamIndex?: number,
            subtitleStreamIndex?: number,
            startIndex?: number,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        postCapabilities: (
            id?: string,
            playableMediaTypes?: MediaType[],
            supportedCommands?: GeneralCommandType[],
            supportsMediaControl?: boolean,
            supportsPersistentIdentifier?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        postFullCapabilities: (
            clientCapabilitiesDto: ClientCapabilitiesDto,
            id?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        removeUserFromSession: (
            sessionId: string,
            userId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        reportSessionEnded: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        reportViewing: (
            itemId: string,
            sessionId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        sendFullGeneralCommand: (
            sessionId: string,
            generalCommand: GeneralCommand,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        sendGeneralCommand: (
            sessionId: string,
            command: GeneralCommandType,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        sendMessageCommand: (
            sessionId: string,
            messageCommand: MessageCommand,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        sendPlaystateCommand: (
            sessionId: string,
            command: PlaystateCommand,
            seekPositionTicks?: number,
            controllingUserId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        sendSystemCommand: (
            sessionId: string,
            command: GeneralCommandType,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • addUserToSession: (
          sessionId: string,
          userId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • displayContent: (
          sessionId: string,
          itemType: BaseItemKind,
          itemId: string,
          itemName: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • getAuthProviders: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>
    • getPasswordResetProviders: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>
    • getSessions: (
          controllableByUserId?: string,
          deviceId?: string,
          activeWithinSeconds?: number,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • play: (
          sessionId: string,
          playCommand: PlayCommand,
          itemIds: string[],
          startPositionTicks?: number,
          mediaSourceId?: string,
          audioStreamIndex?: number,
          subtitleStreamIndex?: number,
          startIndex?: number,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • postCapabilities: (
          id?: string,
          playableMediaTypes?: MediaType[],
          supportedCommands?: GeneralCommandType[],
          supportsMediaControl?: boolean,
          supportsPersistentIdentifier?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • postFullCapabilities: (
          clientCapabilitiesDto: ClientCapabilitiesDto,
          id?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • removeUserFromSession: (
          sessionId: string,
          userId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • reportSessionEnded: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>
    • reportViewing: (
          itemId: string,
          sessionId?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • sendFullGeneralCommand: (
          sessionId: string,
          generalCommand: GeneralCommand,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • sendGeneralCommand: (
          sessionId: string,
          command: GeneralCommandType,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • sendMessageCommand: (
          sessionId: string,
          messageCommand: MessageCommand,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • sendPlaystateCommand: (
          sessionId: string,
          command: PlaystateCommand,
          seekPositionTicks?: number,
          controllingUserId?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • sendSystemCommand: (
          sessionId: string,
          command: GeneralCommandType,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>