Class ServerInvite

Server Invite

Hierarchy

ChannelInvite
- ServerInvite

Index

Constructors

Properties

channelId client? creatorId id serverId type

Accessors

channel creator server

Methods

Constructors

constructor

new ServerInvite(client, invite): ServerInvite
Construct Server Invite
Parameters
- client: Client
  
  Client
- invite: Object
  
  Invite
Returns ServerInvite
Overrides ChannelInvite.constructor
- Defined in src/classes/Invite.ts:55

Properties

`Readonly` channelId

channelId: string

`Protected` `Optional` client

client?: Client

`Readonly` creatorId

creatorId: string

`Readonly` id

id: string

`Readonly` serverId

serverId: string

`Readonly` type

type: "Group" | "None" | "Server"

Accessors

channel

get channel(): undefined | Channel
Channel this invite points to

Returns undefined | Channel
- Defined in src/classes/Invite.ts:81

creator

get creator(): undefined | User
Creator of the invite

Returns undefined | User
- Defined in src/classes/Invite.ts:67

server

get server(): undefined | Server
Server this invite points to

Returns undefined | Server
- Defined in src/classes/Invite.ts:74

Methods

delete

delete(): Promise<void>
Delete the invite

Returns Promise<void>
- Defined in src/classes/Invite.ts:88

`Static` from

from(client, invite): ChannelInvite
Create an Invite from an API Invite
Parameters
- client: Client
  
  Client
- invite: {
      _id: string;
      channel: string;
      creator: string;
      server: string;
      type: "Server";
  } | {
      _id: string;
      channel: string;
      creator: string;
      type: "Group";
  }
  
  Data
Returns ChannelInvite
Invite
Inherited from ChannelInvite.from
- Defined in src/classes/Invite.ts:26

Generated using TypeDoc