Abstract
Readonly
appReadonly
changeChange the primary DC
Readonly
computeCompute new password hash for the given algorithm and password
Readonly
computeCompute SRP parameters for the given password
Readonly
destroy_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
Readonly
disconnectTerminate any connections to the Telegram servers, but keep the client usable
Readonly
exportExport 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
Readonly
getGet the API credentials for use in authorization methods
Readonly
getGenerate a new time-based MTProto message ID
Readonly
getGet the number of connections of the given kind
Readonly
getGet the primary DC ID
Readonly
handleHandle an update sent by the server in response to an RPC call
Updates to handle
Optional
noDispatch: booleanWhether the updates inside should not be dispatched as events
Readonly
importImport 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
).
Session string to import
Optional
force: booleanWhether to overwrite existing session
Readonly
logLogger for the client
Readonly
notifyNotify the client that a channel has been closed
Readonly
notifyNotify the client that a channel has been opened
Readonly
notifyNotify the client that the user has logged in
Readonly
notifyNotify the client that the user has logged out
Emitted when the connection state changes
Emitted when an error occurs
Emitted when an update is received from the server. Requires updates loop to be running
Emitted when a low-level Updates
updates is received
Readonly
optionsReadonly
platformPlatform used by the client
Readonly
prepareADVANCED
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.
Readonly
recreateADVANCED Recreate the given DC, forcefully using the IP taken from server config.
Readonly
startStart the updates loop
Readonly
stopSignal that will be aborted when the client is destroyed
Readonly
stopStop the updates loop
Readonly
storageStorage manager
Readonly
timersTimers manager
Readonly
workerCall an RPC method
Optional
params: RpcCallOptionsInitialize 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.
Abstract
connect
App config manager