Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

Hierarchy

  • Client
    • Client

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Client(apiId: number, apiHash: string): Client

  • Parameters

    • apiId: number
    • apiHash: string

    Returns Client

Properties

connect

connect: function

Type declaration

    • (): Promise<undefined>

    • Returns Promise<undefined>

connectAndLogin

connectAndLogin: function

Type declaration

    • (getLoginDetails: function): Promise<undefined>

    • Parameters

      • getLoginDetails: function
          • (): LoginDetails

          • Returns LoginDetails

      Returns Promise<undefined>

destroy

destroy: function

Type declaration

    • (): undefined

    • Returns undefined

emit

emit: Emit

execute

execute: Execute

invoke

invoke: Invoke

invokeFuture

invokeFuture: InvokeFuture

login

login: function

Type declaration

    • (getLoginDetails: function): Promise<undefined>

    • Parameters

      • getLoginDetails: function
          • (): LoginDetails

          • Returns LoginDetails

      Returns Promise<undefined>

on

on: On

once

once: On

pause

pause: function

Type declaration

    • (): undefined

    • Returns undefined

removeListener

removeListener: RemoveListener

resume

resume: function

Type declaration

    • (): undefined

    • Returns undefined

setLogFatalErrorCallback

setLogFatalErrorCallback: function

Type declaration

    • (fn: null | function): undefined

    • Parameters

      • fn: null | function

      Returns undefined

setLogFilePath

setLogFilePath: function

Type declaration

    • (path: string): number

    • Parameters

      • path: string

      Returns number

setLogMaxFileSize

setLogMaxFileSize: function

Type declaration

    • (maxFileSize: number | string): undefined

    • Parameters

      • maxFileSize: number | string

      Returns undefined

setLogVerbosityLevel

setLogVerbosityLevel: function

Type declaration

    • (verbosity: number): undefined

    • Parameters

      • verbosity: number

      Returns undefined

Methods

getChats

  • getChats(...ids: number[]): Promise<Chat[]>

  • Returns full info of passed chats.

    async

    Parameters

    • Rest ...ids: number[]

      chat IDs.

    Returns Promise<Chat[]>

    Promise resolves Chat[].

getUsers

  • getUsers(contacts: boolean): Promise<IUser[]>

  • Return list of users.

    async

    Parameters

    • contacts: boolean

      If true returns contact list, else returns list of chats.

    Returns Promise<IUser[]>

    List of users.

sendText

  • sendText(chat: string | number, text: string): Promise<Message>

  • Sends message to existing chat.

    async

    Parameters

    • chat: string | number

      Chat title or ID.

    • text: string

      Text to send.

    Returns Promise<Message>

    Promise resolves Message.

Static create

  • create(options?: ConfigType): Client

  • Parameters

    • Optional options: ConfigType

    Returns Client

Static fromTDLib

  • fromTDLib(tdlibInstance: ITDLibJSON, options?: ConfigType): Client

  • Parameters

    • tdlibInstance: ITDLibJSON
    • Optional options: ConfigType

    Returns Client

Generated using TypeDoc