Documentation - v0.27.0
    Preparing search index...

    Interface IAuthKeysRepository

    interface IAuthKeysRepository {
        deleteAll: () => MaybePromise<void>;
        deleteByDc: (dc: number) => MaybePromise<void>;
        get: (dc: number) => MaybePromise<Uint8Array<ArrayBufferLike> | null>;
        getTemp: (
            dc: number,
            idx: number,
            now: number,
        ) => MaybePromise<Uint8Array<ArrayBufferLike> | null>;
        set: (
            dc: number,
            key: Uint8Array<ArrayBufferLike> | null,
        ) => MaybePromise<void>;
        setTemp: (
            dc: number,
            idx: number,
            key: Uint8Array<ArrayBufferLike> | null,
            expires: number,
        ) => MaybePromise<void>;
    }

    Implemented by

    Index

    Properties

    deleteAll deleteByDc get getTemp set setTemp

    Properties

    deleteAll: () => MaybePromise<void>

    Delete all stored auth keys, including both permanent and temp keys

    MUST be applied immediately, without batching

    deleteByDc: (dc: number) => MaybePromise<void>

    Delete all stored auth keys for the given DC, including both permanent and temp keys

    MUST be applied immediately, without batching

    get: (dc: number) => MaybePromise<Uint8Array<ArrayBufferLike> | null>

    Get auth_key for the given DC

    getTemp: (
        dc: number,
        idx: number,
        now: number,
    ) => MaybePromise<Uint8Array<ArrayBufferLike> | null>

    Given the DC id, idx and point in time (in seconds), return the temp_auth_key that should be used for the next request (such that now < key.expires), or null if no such key exists

    set: (dc: number, key: Uint8Array<ArrayBufferLike> | null) => MaybePromise<void>

    Store auth_key for the given DC

    If key is null, the key should be deleted instead

    MUST be applied immediately, without batching

    setTemp: (
        dc: number,
        idx: number,
        key: Uint8Array<ArrayBufferLike> | null,
        expires: number,
    ) => MaybePromise<void>

    Store temp_auth_key for the given DC and idx, along with its expiration date (in seconds)

    If key is null, the key should be deleted instead

    MUST be applied immediately, without batching

    Settings

    Member Visibility

    On This Page

    Properties