Class MtClient

Basic MTProto client implementation, only doing the bare minimum to make RPC calls and receive low-level updates, as well as providing some APIs to manage that.

Constructors

constructor

Properties

_config _defaultDcs _layer _readerMap _testMode _writerMap crypto log network onConnecting onNetworkChanged onUpdate onUsable params stopSignal storage

Methods

call close connect emitError onError prepare

Constructors

constructor

Properties

Readonly_config

_config: ConfigManager = ...

_defaultDcs

_defaultDcs: DcOptions

Primary DCs taken from MtClientOptions.defaultDcs, loaded from session or changed by other means (like redirecting).

Readonly_layer

_layer: number

TL layer used by the client

Readonly_readerMap

_readerMap: TlReaderMap

TL readers map used by the client

Protected Readonly_testMode

_testMode: boolean

"Test mode" taken from MtClientOptions.testMode

Readonly_writerMap

_writerMap: TlWriterMap

TL writers map used by the client

Readonlycrypto

crypto: ICryptoProvider

Crypto provider taken from MtClientOptions.crypto

Readonlylog

log: Logger

Readonlynetwork

network: NetworkManager

ReadonlyonConnecting

onConnecting: Emitter<void> = ...

ReadonlyonNetworkChanged

onNetworkChanged: Emitter<boolean> = ...

ReadonlyonUpdate

onUpdate: Emitter<TypeUpdates> = ...

ReadonlyonUsable

onUsable: Emitter<void> = ...

Readonlyparams

params: MtClientOptions

ReadonlystopSignal

stopSignal: AbortSignal

Readonlystorage

storage: StorageManager

Storage manager

Methods

call

  • call<T extends RpcMethod>(
        message: MustEqual<T, RpcMethod>,
        params?: RpcCallOptions,
    ): Promise<RawMt_rpc_error | RpcCallReturn[T["_"]]>

  • Make an RPC call.

    The connection must have been connect-ed before calling this method.

    This method is still quite low-level and you shouldn't use this when using high-level API provided by @mtcute/client.

    Type Parameters

    • T extends RpcMethod

    Parameters

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

close

  • close(): Promise<void>

  • Close all connections and finalize the client.

    Returns Promise<void>

connect

  • connect(): Promise<void>

  • Initialize the connection to the primary DC.

    You shouldn't usually call this method directly as it is called implicitly the first time you call call.

    Returns Promise<void>

emitError

  • emitError(err: unknown): void

  • Parameters

    • err: unknown

    Returns void

onError

  • onError(handler: (err: unknown) => void): void

  • Register an error handler for the client

    Parameters

    • handler: (err: unknown) => void

      Error handler.

    Returns void

prepare

  • prepare(): Promise<void>

  • ADVANCED

    Do all the preparations, but don't connect just yet. Useful when you want to do some preparations before connecting, like setting up session.

    Call connect to actually connect.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods