Class GlobalInvite

Hierarchy

BaseObject<APIGlobalInvite>
- GlobalInvite

Index

Constructors

Properties

Accessors

_id channel createdAt creator id server source type

Methods

accept fireUpdate offUpdate onUpdate toString update

Constructors

constructor

new GlobalInvite(client: Client, data: APIGlobalInvite): GlobalInvite
Parameters
- client: Client
- data: APIGlobalInvite
Returns GlobalInvite
Overrides BaseObject.constructor
- Defined in core/src/objects/GlobalInvite.ts:19

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

channel

get channel(): {
    description: string;
    id: string;
    name: string;
}
Returns {
    description: string;
    id: string;
    name: string;
}
- description: string
- id: string
- name: string
- Defined in core/src/objects/GlobalInvite.ts:33

createdAt

get createdAt(): number
Invites don't have a creation date.

Returns number
Overrides BaseObject.createdAt
- Defined in core/src/objects/GlobalInvite.ts:16

creator

get creator(): {
avatar: Attachment;
name: string;
}
Returns {
avatar: Attachment;
name: string;
}
- avatar: Attachment
- name: string
- Defined in core/src/objects/GlobalInvite.ts:27

id

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

server

get server(): GlobalInviteServer
Returns GlobalInviteServer
- Defined in core/src/objects/GlobalInvite.ts:40

source

get source(): APIType
Original API object.

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

type

get type(): "Group" | "Server"
Returns "Group" | "Server"
- Defined in core/src/objects/GlobalInvite.ts:23

Methods

accept

accept(): Promise<GroupDMChannel | Server>
Returns Promise<GroupDMChannel | Server>
- Defined in core/src/objects/GlobalInvite.ts:56

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>): GlobalInvite
Stops listening for Map updates.

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

onUpdate

onUpdate(callback: MiniEmitterCallback<any>): GlobalInvite
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 GlobalInvite
Inherited from BaseObject.onUpdate
- Defined in core/src/utils/MiniEmitter.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<APIGlobalInvite>): GlobalInvite
Update this object with new API data.
Parameters
- data: Partial<APIGlobalInvite> = {}
Returns GlobalInvite
Inherited from BaseObject.update
- Defined in core/src/objects/BaseObject.ts:24