Class Session`Abstract`

Hierarchy (View Summary)

Session
- MemorySession

Index

Accessors

authKey dcId port serverAddress testServers

Constructors

Methods

close delete getAuthKey getInputEntity load processEntities save setAuthKey setDC

Accessors

`Abstract`authKey

get authKey(): AuthKey | undefined
Returns an AuthKey instance associated with the saved data center, or undefined if a new one should be generated.

Returns AuthKey | undefined
- Defined in teleproto/sessions/Abstract.ts:58
set authKey(value: AuthKey | undefined): void
Sets the AuthKey to be used for the saved data center.
Parameters
- value: AuthKey | undefined
Returns void
- Defined in teleproto/sessions/Abstract.ts:64

`Abstract`dcId

get dcId(): number
Returns the currently-used data center ID.

Returns number
- Defined in teleproto/sessions/Abstract.ts:30

`Abstract`port

get port(): number
Returns the port to which the library should connect to.

Returns number
- Defined in teleproto/sessions/Abstract.ts:40

`Abstract`serverAddress

get serverAddress(): string
Returns the server address where the library should connect to.

Returns string
- Defined in teleproto/sessions/Abstract.ts:35

testServers

get testServers(): boolean
Returns boolean
- Defined in teleproto/sessions/Abstract.ts:47
set testServers(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in teleproto/sessions/Abstract.ts:50

Constructors

constructor

new Session(): Session

Returns Session

Methods

`Abstract`close

close(): void
Called on client disconnection. Should be used to free any used resources. Can be left empty if none.

Returns void
- Defined in teleproto/sessions/Abstract.ts:142

`Abstract`delete

delete(): void | Promise<void>
Called upon client.logOut(). Should delete the stored information from disk since it's not valid anymore.

Returns void | Promise<void>
- Defined in teleproto/sessions/Abstract.ts:155

`Abstract`getAuthKey

getAuthKey(dcId?: number): AuthKey | undefined
gets auth key for a dc
Parameters
- OptionaldcId: number
Returns AuthKey | undefined
- Defined in teleproto/sessions/Abstract.ts:80

`Abstract`getInputEntity

getInputEntity(key: EntityLike): TypeInputPeer | Promise<TypeInputPeer>
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 | Promise<TypeInputPeer>
- Defined in teleproto/sessions/Abstract.ts:88

`Abstract`load

load(): Promise<void>
Called before using the session

Returns Promise<void>
- Defined in teleproto/sessions/Abstract.ts:69

`Abstract`processEntities

processEntities(tlo: any): void | Promise<void>
Processes the input TLObject or list and saves whatever information is relevant (e.g., ID or access hash). May be asynchronous; the library awaits the result where possible, and a storage failure never fails the request that produced it.
Parameters
- tlo: any
Returns void | Promise<void>
- Defined in teleproto/sessions/Abstract.ts:164

`Abstract`save

save(): string | void
called whenever important properties change. It should make persist the relevant session information to disk.

Returns string | void
- Defined in teleproto/sessions/Abstract.ts:148

`Abstract`setAuthKey

setAuthKey(authKey?: AuthKey, dcId?: number): void
sets auth key for a dc
Parameters
- OptionalauthKey: AuthKey
- OptionaldcId: number
Returns void
- Defined in teleproto/sessions/Abstract.ts:74

`Abstract`setDC

setDC(dcId: number, serverAddress: string, port: number): void
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
  {number}
- serverAddress: string
  {string}
- port: number
  {number}
Returns void
- Defined in teleproto/sessions/Abstract.ts:25