Class TakeoutSession

constructor

• new TakeoutSession(client, session): TakeoutSession

• Parameters

  • client: ITelegramClient
  • session: RawTakeout

  Returns TakeoutSession

Readonlyclient

Readonlyid

call

• call<T>(message, params?): 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

    Additional call parameters

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

createProxy

• createProxy(predicate?): 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.

  Note: This will return a Proxy object that overrides call method. Using this method requires that your target environment supports Proxy and Reflect APIs

  Parameters

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

    Function that given the RPC call should determine whether that call should be called via takeout session or not. Returning true will use takeout session, false will not.

    • • (obj): boolean

      • Parameters

        • obj: TlObject

        Returns boolean

  Returns ITelegramClient

finish

• finish(success?): Promise<void>

• Finish account takeout session

  Parameters

  • success: boolean = true

    Whether the data was successfully exported

  Returns Promise<void>