Class BaseTelegramClient

ReadonlyappConfig

Readonlycrypto

Readonlylog

Readonlymt

ReadonlyonConnectionState

onError

ReadonlyonRawUpdate

ReadonlyonServerUpdate

Readonlyparams

Readonlyplatform

Readonlystorage

Readonlytimers

Optional Readonlyupdates

isConnected

• get isConnected(): boolean

• Returns boolean

stopSignal

• get stopSignal(): AbortSignal

• Signal that will be aborted when the client is destroyed

  Returns AbortSignal

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

• Returns Promise<void>

call

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

• Make an RPC call

  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

  • message: MustEqual<T, RpcMethod>

    RPC method to call
  • Optionalparams: RpcCallOptions

    Additional call parameters

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

changePrimaryDc

• changePrimaryDc(dcId: number): Promise<void>

• Change the primary DC

  Parameters

  • dcId: number

  Returns Promise<void>

computeNewPasswordHash

• computeNewPasswordHash(
      algo: TypePasswordKdfAlgo,
      password: string,
  ): Promise<Uint8Array>

• Compute new password hash for the given algorithm and password

  Parameters

  • algo: TypePasswordKdfAlgo
  • password: string

  Returns Promise<Uint8Array>

computeSrpParams

• computeSrpParams(
      request: RawPassword,
      password: string,
  ): Promise<RawInputCheckPasswordSRP>

• Compute SRP parameters for the given password

  Parameters

  • request: RawPassword
  • password: string

  Returns Promise<RawInputCheckPasswordSRP>

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>

destroy

• destroy(): Promise<void>

• Destroy the client and all its resources.

  This will terminate any connections to the Telegram servers, free all the resources, and make the client no longer usable

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• Terminate any connections to the Telegram servers, but keep the client usable

  Returns Promise<void>

exportSession

• exportSession(): Promise<string>

• Export current session to a single LONG string, containing all the needed information.

  Warning! Anyone with this string will be able to authorize as you and do anything. Treat this as your password, and never give it away!

  In case you have accidentally leaked this string, make sure to revoke this session in account settings: "Privacy & Security" > "Active sessions" > find the one containing mtcute > Revoke, or, in case this is a bot, revoke bot token with @BotFather

  Returns Promise<string>

getApiCredentials

• getApiCredentials(): Promise<{ hash: string; id: number }>

• Get the API credentials for use in authorization methods

  Returns Promise<{ hash: string; id: number }>

getMtprotoMessageId

• getMtprotoMessageId(): Promise<Long>

• Generate a new time-based MTProto message ID

  Returns Promise<Long>

getPoolSize

• getPoolSize(kind: ConnectionKind, dcId?: number): Promise<number>

• Get the number of connections of the given kind

  Parameters

  • kind: ConnectionKind
  • OptionaldcId: number

  Returns Promise<number>

getPrimaryDcId

• getPrimaryDcId(): Promise<number>

• Get the primary DC ID

  Returns Promise<number>

handleClientUpdate

• handleClientUpdate(updates: TypeUpdates, noDispatch?: boolean): void

• Handle an update sent by the server in response to an RPC call

  Parameters

  • updates: TypeUpdates

    Updates to handle
  • OptionalnoDispatch: boolean

    Whether the updates inside should not be dispatched as events

  Returns void

importSession

• importSession(
      session: string | InputStringSessionData,
      force?: boolean,
  ): Promise<void>

• Import the session from the given session string.

  Note that the session will only be imported in case the storage is missing authorization (i.e. does not contain auth key for the primary DC), otherwise it will be ignored (unless force).

  Parameters

  • session: string | InputStringSessionData

    Session string to import
  • force: boolean = false

    Whether to overwrite existing session

  Returns Promise<void>

notifyChannelClosed

• notifyChannelClosed(channelId: number): Promise<boolean>

• Notify the client that a channel has been closed

  Parameters

  • channelId: number

  Returns Promise<boolean>

notifyChannelOpened

• notifyChannelOpened(channelId: number, pts?: number): Promise<boolean>

• Notify the client that a channel has been opened

  Parameters

  • channelId: number
  • Optionalpts: number

  Returns Promise<boolean>

notifyLoggedIn

• notifyLoggedIn(auth: RawUser | TypeAuthorization): Promise<RawUser>

• Notify the client that the user has logged in

  Parameters

  • auth: RawUser | TypeAuthorization

  Returns Promise<RawUser>

notifyLoggedOut

• notifyLoggedOut(): Promise<void>

• Notify the client that the user has logged out

  Returns Promise<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>

recreateDc

• recreateDc(dcId: number): Promise<void>

• ADVANCED Recreate the given DC, forcefully using the IP taken from server config.

  Parameters

  • dcId: number

  Returns Promise<void>

startUpdatesLoop

• startUpdatesLoop(): Promise<void>

• Start the updates loop

  Returns Promise<void>

stopUpdatesLoop

• stopUpdatesLoop(): Promise<void>

• Stop the updates loop

  Returns Promise<void>