Class TakeoutSession

constructor

• new TakeoutSession(client: ITelegramClient, session: RawTakeout): TakeoutSession

  Parameters

  • client: ITelegramClient
  • session: RawTakeout

  Returns TakeoutSession

Readonlyclient

Readonlyid

call

• call<T extends RpcMethod>(
      message: MustEqual<T, RpcMethod>,
      params?: RpcCallOptions & { withMessageRange?: RawMessageRange },
  ): Promise<RpcCallReturn[T["_"]]>

  Make an API call using this takeout session

  This method just wraps the query into invokeWithTakeout and passes the control down to TelegramClient.call.

  Type Parameters

  • T extends RpcMethod

  Parameters

  • message: MustEqual<T, RpcMethod>

    RPC method to call

  • Optionalparams: RpcCallOptions & { withMessageRange?: RawMessageRange }

    Additional call parameters

    • OptionalwithMessageRange?: RawMessageRange

      If passed, the request will be wrapped in an invokeWithMessagesRange

  Returns Promise<RpcCallReturn[T["_"]]>

createProxy

• createProxy(
      params?: RpcCallOptions & {
          predicate?: (obj: TlObject) => boolean;
          withMessageRange?: RawMessageRange;
      },
  ): ITelegramClient

  Create a proxy over TelegramClient that will use this takeout session to call methods.

  You can optionally provide a function to check if some RPC method should be called via a takeout session or directly, otherwise all methods are called through the takeout session.

  Parameters

  • Optionalparams: RpcCallOptions & {
        predicate?: (obj: TlObject) => boolean;
        withMessageRange?: RawMessageRange;
    }

    • Optionalpredicate?: (obj: TlObject) => boolean

      Function that given the RPC call should determine whether that call should be called via takeout session (and use the rest of the params passed here) or not. Returning true will use takeout session, false will call the method directly.

      Default

      undefined, i.e. all calls are sent via takeout session

    • OptionalwithMessageRange?: RawMessageRange

      If passed, the request will be wrapped in an invokeWithMessagesRange

  Returns ITelegramClient

finish

• finish(success?: boolean): Promise<void>

  Finish account takeout session

  Parameters

  • success: boolean = true

    Whether the data was successfully exported

  Returns Promise<void>