Class AuthSession

Hierarchy

BaseObject<APISessionInfo>
- AuthSession

Index

Constructors

Properties

Accessors

_id createdAt id name source token

Methods

fireUpdate offUpdate onUpdate setToken toString update

Constructors

constructor

new AuthSession(client: Client, data: APISessionInfo): AuthSession
Parameters
- client: Client
- data: APISessionInfo
Returns AuthSession
Overrides BaseObject.constructor
- Defined in core/src/objects/AuthSession.ts:6

Properties

client

client: Client

deleted

deleted: boolean = false

Accessors

`Protected` _id

get _id(): ""
Returns ""
Inherited from BaseObject._id
- Defined in core/src/objects/BaseObject.ts:10

createdAt

get createdAt(): number
Returns number
Inherited from BaseObject.createdAt
- Defined in core/src/objects/BaseObject.ts:19

id

get id(): string
Returns string
Inherited from BaseObject.id
- Defined in core/src/objects/BaseObject.ts:16

name

get name(): string
Returns string
- Defined in core/src/objects/AuthSession.ts:9

source

get source(): APIType
Original API object.

Returns APIType
Inherited from BaseObject.source
- Defined in core/src/objects/BaseObject.ts:7

token

get token(): string
Returns string
- Defined in core/src/objects/AuthSession.ts:12

Methods

fireUpdate

fireUpdate(updated?: any[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: any[]
  
  The objects that caused this update.
Returns void
Inherited from BaseObject.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:33

offUpdate

offUpdate(callback: MiniEmitterCallback<any>): AuthSession
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to stop listening for updates on.
Returns AuthSession
Inherited from BaseObject.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:24

onUpdate

onUpdate(callback: MiniEmitterCallback<any>): AuthSession
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to run when an update occurs.
Returns AuthSession
Inherited from BaseObject.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:15

setToken

setToken(token: string): AuthSession
Parameters
- token: string
Returns AuthSession
- Defined in core/src/objects/AuthSession.ts:15

toString

toString(): string
Converts this object to a string.

Returns
The object ID.

Returns string
Inherited from BaseObject.toString
- Defined in core/src/objects/BaseObject.ts:33

update

update(data?: Partial<APISessionInfo>): AuthSession
Update this object with new API data.
Parameters
- data: Partial<APISessionInfo> = {}
Returns AuthSession
Inherited from BaseObject.update
- Defined in core/src/objects/BaseObject.ts:24