Interface ITelegramClient

interface ITelegramClient {
    appConfig: PublicPart<AppConfigManager>;
    log: Logger;
    onConnectionState: Emitter<ConnectionState>;
    onError: Emitter<Error>;
    onRawUpdate: Emitter<RawUpdateInfo>;
    onServerUpdate: Emitter<TypeUpdates>;
    platform: ICorePlatform;
    stopSignal: AbortSignal;
    storage: PublicPart<TelegramStorageManager>;
    timers: Pick<TimersManager, "cancel" | "create" | "exists">;
    call<T extends RpcMethod>(
        message: MustEqual<T, RpcMethod>,
        params?: RpcCallOptions,
    ): Promise<RpcCallReturn[T["_"]]>;
    changePrimaryDc(newDc: number): Promise<void>;
    close(): Promise<void>;
    computeNewPasswordHash(
        algo: TypePasswordKdfAlgo,
        password: string,
    ): Promise<Uint8Array>;
    computeSrpParams(
        request: RawPassword,
        password: string,
    ): Promise<RawInputCheckPasswordSRP>;
    connect(): Promise<void>;
    exportSession(): Promise<string>;
    getApiCredentials(): Promise<{ hash: string; id: number }>;
    getMtprotoMessageId(): Promise<Long>;
    getPoolSize(kind: ConnectionKind, dcId?: number): Promise<number>;
    getPrimaryDcId(): Promise<number>;
    handleClientUpdate(updates: TypeUpdates, noDispatch?: boolean): void;
    importSession(
        session: string | InputStringSessionData,
        force?: boolean,
    ): Promise<void>;
    notifyChannelClosed(channelId: number): Promise<boolean>;
    notifyChannelOpened(channelId: number, pts?: number): Promise<boolean>;
    notifyLoggedIn(auth: RawUser | TypeAuthorization): Promise<RawUser>;
    notifyLoggedOut(): Promise<void>;
    prepare(): Promise<void>;
    recreateDc(dcId: number): Promise<void>;
    startUpdatesLoop(): Promise<void>;
    stopUpdatesLoop(): Promise<void>;
}

Properties

appConfig log onConnectionState onError onRawUpdate onServerUpdate platform stopSignal storage timers

Methods

call changePrimaryDc close computeNewPasswordHash computeSrpParams connect exportSession getApiCredentials getMtprotoMessageId getPoolSize getPrimaryDcId handleClientUpdate importSession notifyChannelClosed notifyChannelOpened notifyLoggedIn notifyLoggedOut prepare recreateDc startUpdatesLoop stopUpdatesLoop

Properties

ReadonlyappConfig

appConfig: PublicPart<AppConfigManager>

Readonlylog

log: Logger

onConnectionState

onConnectionState: Emitter<ConnectionState>

onError

onError: Emitter<Error>

onRawUpdate

onRawUpdate: Emitter<RawUpdateInfo>

onServerUpdate

onServerUpdate: Emitter<TypeUpdates>

Readonlyplatform

platform: ICorePlatform

ReadonlystopSignal

stopSignal: AbortSignal

Readonlystorage

storage: PublicPart<TelegramStorageManager>

Readonlytimers

timers: Pick<TimersManager, "cancel" | "create" | "exists">

Methods

call

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

  • Type Parameters

    • T extends RpcMethod

    Parameters

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

changePrimaryDc

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

  • Parameters

    • newDc: number

    Returns Promise<void>

close

  • close(): Promise<void>

  • Returns Promise<void>

computeNewPasswordHash

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

  • Parameters

    Returns Promise<Uint8Array>

computeSrpParams

connect

  • connect(): Promise<void>

  • Returns Promise<void>

exportSession

  • exportSession(): Promise<string>

  • Returns Promise<string>

getApiCredentials

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

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

getMtprotoMessageId

  • getMtprotoMessageId(): Promise<Long>

  • Returns Promise<Long>

getPoolSize

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

  • Parameters

    Returns Promise<number>

getPrimaryDcId

  • getPrimaryDcId(): Promise<number>

  • Returns Promise<number>

handleClientUpdate

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

  • Parameters

    Returns void

importSession

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

  • Parameters

    Returns Promise<void>

notifyChannelClosed

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

  • Parameters

    • channelId: number

    Returns Promise<boolean>

notifyChannelOpened

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

  • Parameters

    • channelId: number
    • Optionalpts: number

    Returns Promise<boolean>

notifyLoggedIn

notifyLoggedOut

  • notifyLoggedOut(): Promise<void>

  • Returns Promise<void>

prepare

  • prepare(): Promise<void>

  • Returns Promise<void>

recreateDc

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

  • Parameters

    • dcId: number

    Returns Promise<void>

startUpdatesLoop

  • startUpdatesLoop(): Promise<void>

  • Returns Promise<void>

stopUpdatesLoop

  • stopUpdatesLoop(): Promise<void>

  • Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods