Class ServerInvite

Hierarchy

BaseObject<Invite>
- ServerInvite

Index

Constructors

constructor

new ServerInvite(client: Client, data: {
    _id: string;
    channel: string;
    creator: string;
    server: string;
    type: "Server";
} | {
    _id: string;
    channel: string;
    creator: string;
    type: "Group";
}): ServerInvite
Parameters
- client: Client
- data: {
      _id: string;
      channel: string;
      creator: string;
      server: string;
      type: "Server";
  } | {
      _id: string;
      channel: string;
      creator: string;
      type: "Group";
  }
Returns ServerInvite
Overrides BaseObject.constructor
- Defined in core/src/objects/ServerInvite.ts:10

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(): Channel
Returns Channel
- Defined in core/src/objects/ServerInvite.ts:31

channelID

get channelID(): string
Returns string
- Defined in core/src/objects/ServerInvite.ts:28

createdAt

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

Returns number
Overrides BaseObject.createdAt
- Defined in core/src/objects/ServerInvite.ts:7

creator

get creator(): User
Returns User
- Defined in core/src/objects/ServerInvite.ts:21

creatorID

get creatorID(): string
Returns string
- Defined in core/src/objects/ServerInvite.ts:18

id

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

server

get server(): Server
Returns Server
- Defined in core/src/objects/ServerInvite.ts:41

serverID

get serverID(): string
Returns string
- Defined in core/src/objects/ServerInvite.ts:38

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/ServerInvite.ts:14

Methods

delete

delete(): Promise<void>
Returns Promise<void>
- Defined in core/src/objects/ServerInvite.ts:53

fetchChannel

fetchChannel(): Promise<Channel>
Returns Promise<Channel>
- Defined in core/src/objects/ServerInvite.ts:34

fetchCreator

fetchCreator(fetchNew?: boolean): Promise<User>
Parameters
- fetchNew: boolean = false
Returns Promise<User>
- Defined in core/src/objects/ServerInvite.ts:24

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

generateURL

generateURL(base?: string): string
Generates a url for this invite.
Parameters
- base: string = "https://rvlt.gg"
  
  The base url to use without a trailing slash. (default: https://rvlt.gg)
Returns string
- Defined in core/src/objects/ServerInvite.ts:49

offUpdate

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

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

onUpdate

onUpdate(callback: MiniEmitterCallback<any>): ServerInvite
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 ServerInvite
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<{
    _id: string;
    channel: string;
    creator: string;
    server: string;
    type: "Server";
} | {
    _id: string;
    channel: string;
    creator: string;
    type: "Group";
}>): ServerInvite
Update this object with new API data.
Parameters
- data: Partial<{
      _id: string;
      channel: string;
      creator: string;
      server: string;
      type: "Server";
  } | {
      _id: string;
      channel: string;
      creator: string;
      type: "Group";
  }> = {}
Returns ServerInvite
Inherited from BaseObject.update
- Defined in core/src/objects/BaseObject.ts:24

Class ServerInvite

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

data: { _id: string; channel: string; creator: string; server: string; type: "Server"; } | { _id: string; channel: string; creator: string; type: "Group"; }

Returns ServerInvite

Properties

client

deleted

Accessors

Protected _id

Returns ""

channel

Returns Channel

channelID

Returns string

createdAt

Returns number

creator

Returns User

creatorID

Returns string

id

Returns string

server

Returns Server

serverID

Returns string

source

Returns APIType

type

Returns "Group" | "Server"

Methods

delete

Returns Promise<void>

fetchChannel

Returns Promise<Channel>

fetchCreator

Parameters

fetchNew: boolean = false

Returns Promise<User>

fireUpdate

Parameters

Optional updated: any[]

Returns void

generateURL

Parameters

base: string = "https://rvlt.gg"

Returns string

offUpdate

Returns

Parameters

callback: MiniEmitterCallback<any>

Returns ServerInvite

onUpdate

Returns

Parameters

callback: MiniEmitterCallback<any>

Returns ServerInvite

toString

Returns

Returns string

update

Parameters

data: Partial<{ _id: string; channel: string; creator: string; server: string; type: "Server"; } | { _id: string; channel: string; creator: string; type: "Group"; }> = {}

Returns ServerInvite

data: {
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
}

`Protected` _id

`Optional` updated: any[]

data: Partial<{
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
} | {
_id: string;
channel: string;
creator: string;
type: "Group";
}> = {}