Class StoreSession

Hierarchy

MemorySession
- StoreSession

Properties

Protected Optional _serverAddress

_serverAddress?: string

Protected _dcId

_dcId: number

Protected Optional _port

_port?: number

Protected _takeoutId

_takeoutId: undefined

Protected _entities

_entities: Set<any>

Protected _updateStates

_updateStates: {}

Type declaration

Protected Optional _authKey

_authKey?: AuthKey

Accessors

dcId

get dcId(): number

Inherited from MemorySession.dcId
- Defined in gramjs/sessions/Memory.ts:38
Returns number

serverAddress

get serverAddress(): string

Inherited from MemorySession.serverAddress
- Defined in gramjs/sessions/Memory.ts:42
Returns string

port

get port(): number

Inherited from MemorySession.port
- Defined in gramjs/sessions/Memory.ts:46
Returns number

takeoutId

get takeoutId(): undefined
set takeoutId(value: undefined): void

Inherited from MemorySession.takeoutId
- Defined in gramjs/sessions/Memory.ts:58
Returns undefined
Inherited from MemorySession.takeoutId
- Defined in gramjs/sessions/Memory.ts:62
Parameters
- value: undefined
Returns void

authKey

get authKey(): undefined | AuthKey
set authKey(value: undefined | AuthKey): void

Overrides MemorySession.authKey
- Defined in gramjs/sessions/StoreSession.ts:66
Returns undefined | AuthKey
Overrides MemorySession.authKey
- Defined in gramjs/sessions/StoreSession.ts:61
Parameters
- value: undefined | AuthKey
Returns void

Methods

getAuthKey

getAuthKey(dcId?: number): undefined | AuthKey

Inherited from MemorySession.getAuthKey
- Defined in gramjs/sessions/Memory.ts:66
gets auth key for a dc

Parameters
- Optional dcId: number
Returns undefined | AuthKey

setAuthKey

setAuthKey(authKey?: AuthKey, dcId?: number): undefined

Inherited from MemorySession.setAuthKey
- Defined in gramjs/sessions/Memory.ts:75
sets auth key for a dc

Parameters
- Optional authKey: AuthKey
- Optional dcId: number
Returns undefined

close

close(): void

Inherited from MemorySession.close
- Defined in gramjs/sessions/Memory.ts:84
Called on client disconnection. Should be used to free any used resources. Can be left empty if none.

Returns void

save

save(): void

Inherited from MemorySession.save
- Defined in gramjs/sessions/Memory.ts:86
called whenever important properties change. It should make persist the relevant session information to disk.

Returns void

delete

delete(): void

Inherited from MemorySession.delete
- Defined in gramjs/sessions/Memory.ts:90
Called upon client.log_out(). Should delete the stored information from disk since it's not valid anymore.

Returns void

_entityValuesToRow

_entityValuesToRow(id: string | BigInteger, hash: string | BigInteger, username: string, phone: string, name: string): (string | BigInteger)[]

Inherited from MemorySession._entityValuesToRow
- Defined in gramjs/sessions/Memory.ts:92
Parameters
- id: string | BigInteger
- hash: string | BigInteger
- username: string
- phone: string
- name: string
Returns (string | BigInteger)[]

_entityToRow

_entityToRow(e: any): undefined | (string | BigInteger)[]

Inherited from MemorySession._entityToRow
- Defined in gramjs/sessions/Memory.ts:105
Parameters
- e: any
Returns undefined | (string | BigInteger)[]

_entitiesToRows

_entitiesToRows(tlo: any): (string | BigInteger)[][]

Inherited from MemorySession._entitiesToRows
- Defined in gramjs/sessions/Memory.ts:138
Parameters
- tlo: any
Returns (string | BigInteger)[][]

getEntityRowsByPhone

getEntityRowsByPhone(phone: string): undefined | any[]

Inherited from MemorySession.getEntityRowsByPhone
- Defined in gramjs/sessions/Memory.ts:179
Parameters
- phone: string
Returns undefined | any[]

getEntityRowsByUsername

getEntityRowsByUsername(username: string): undefined | any[]

Inherited from MemorySession.getEntityRowsByUsername
- Defined in gramjs/sessions/Memory.ts:188
Parameters
- username: string
Returns undefined | any[]

getEntityRowsByName

getEntityRowsByName(name: string): undefined | any[]

Inherited from MemorySession.getEntityRowsByName
- Defined in gramjs/sessions/Memory.ts:197
Parameters
- name: string
Returns undefined | any[]

getInputEntity

getInputEntity(key: EntityLike): TypeInputPeer

Inherited from MemorySession.getInputEntity
- Defined in gramjs/sessions/Memory.ts:231
Turns the given key into an InputPeer (e.g. InputPeerUser). The library uses this method whenever an InputPeer is needed to suit several purposes (e.g. user only provided its ID or wishes to use a cached username to avoid extra RPC).

Parameters
- key: EntityLike
Returns TypeInputPeer

load

load(): Promise<void>

Overrides MemorySession.load
- Defined in gramjs/sessions/StoreSession.ts:27
Called before using the session

Returns Promise<void>

setDC

setDC(dcId: number, serverAddress: string, port: number): void

Overrides MemorySession.setDC
- Defined in gramjs/sessions/StoreSession.ts:54
Sets the information of the data center address and port that the library should connect to, as well as the data center ID, which is currently unused.

Parameters
- dcId: number
- serverAddress: string
- port: number
Returns void

processEntities

processEntities(tlo: any): void

Overrides MemorySession.processEntities
- Defined in gramjs/sessions/StoreSession.ts:70
Processes the input TLObject or list and saves whatever information is relevant (e.g., ID or access hash).

Parameters
- tlo: any
Returns void

getEntityRowsById

getEntityRowsById(id: string | BigInteger, exact?: boolean): any

Overrides MemorySession.getEntityRowsById
- Defined in gramjs/sessions/StoreSession.ts:81
Parameters
- id: string | BigInteger
- exact: boolean = true
Returns any

Constructors

constructor

new StoreSession(sessionName: string, divider?: string): StoreSession

Overrides MemorySession.constructor
- Defined in gramjs/sessions/StoreSession.ts:10
Parameters
- sessionName: string
- divider: string = ":"
Returns StoreSession

Generated using TypeDoc