Class ServerInvite

Server Invite

Hierarchy (View Summary)

ChannelInvite
- ServerInvite

Index

Constructors

constructor

new ServerInvite(
    client: Client,
    invite: (
        | {
            _id: string;
            channel: string;
            creator: string;
            expires?: null
            | string;
            max_uses?: null | number;
            server: string;
            type: "Server";
            uses: number;
        }
        | {
            _id: string;
            channel: string;
            creator: string;
            expires?: null
            | string;
            max_uses?: null | number;
            type: "Group";
            uses: number;
        }
    ) & { type: "Server" },
): ServerInvite
Construct Server Invite
Parameters
- client: Client
  Client
- invite: (
      | {
          _id: string;
          channel: string;
          creator: string;
          expires?: null
          | string;
          max_uses?: null | number;
          server: string;
          type: "Server";
          uses: number;
      }
      | {
          _id: string;
          channel: string;
          creator: string;
          expires?: null
          | string;
          max_uses?: null | number;
          type: "Group";
          uses: number;
      }
  ) & { type: "Server" }
  Invite
  - {
        _id: string;
        channel: string;
        creator: string;
        expires?: null | string;
        max_uses?: null | number;
        server: string;
        type: "Server";
        uses: number;
    }
    _id: string
    Description
    Invite code
    
    channel: string
    Description
    Id of the server channel this invite points to
    
    creator: string
    Description
    Id of user who created this invite
    
    Optionalexpires?: null | string
    Description
    Timestamp at which this invite expires
    
    Optionalmax_uses?: null | number
    Format: uint64
    
    Description
    Maximum number of times this invite can be used
    
    server: string
    Description
    Id of the server this invite points to
    
    type: "Server"
    uses: number
    Format: uint64
    
    Description
    Number of times this invite has been used
  - {
        _id: string;
        channel: string;
        creator: string;
        expires?: null | string;
        max_uses?: null | number;
        type: "Group";
        uses: number;
    }
    _id: string
    Description
    Invite code
    
    channel: string
    Description
    Id of the group channel this invite points to
    
    creator: string
    Description
    Id of user who created this invite
    
    Optionalexpires?: null | string
    Description
    Timestamp at which this invite expires
    
    Optionalmax_uses?: null | number
    Format: uint64
    
    Description
    Maximum number of times this invite can be used
    
    type: "Group"
    uses: number
    Format: uint64
    
    Description
    Number of times this invite has been used
  - type: "Server"
Returns ServerInvite
Overrides ChannelInvite.constructor
- Defined in src/classes/Invite.ts:64

Properties

`Readonly`channelId

channelId: string

`Protected` `Optional`client

client?: Client

`Readonly`creatorId

creatorId: string

`Optional` `Readonly`expires

expires?: Date

`Readonly`id

id: string

`Optional` `Readonly`maxUses

maxUses?: number

`Readonly`serverId

serverId: string

`Readonly`type

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

`Optional` `Readonly`uses

uses?: number

Accessors

channel

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

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

creator

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

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

server

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

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

Methods

delete

delete(): Promise<void>
Delete the invite

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

`Static`from

from(
    client: Client,
    invite:
        | {
            _id: string;
            channel: string;
            creator: string;
            expires?: null
            | string;
            max_uses?: null | number;
            server: string;
            type: "Server";
            uses: number;
        }
        | {
            _id: string;
            channel: string;
            creator: string;
            expires?: null
            | string;
            max_uses?: null | number;
            type: "Group";
            uses: number;
        },
): ChannelInvite
Create an Invite from an API Invite
Parameters
- client: Client
  Client
- invite:
      | {
          _id: string;
          channel: string;
          creator: string;
          expires?: null
          | string;
          max_uses?: null | number;
          server: string;
          type: "Server";
          uses: number;
      }
      | {
          _id: string;
          channel: string;
          creator: string;
          expires?: null
          | string;
          max_uses?: null | number;
          type: "Group";
          uses: number;
      }
  Data
  - {
        _id: string;
        channel: string;
        creator: string;
        expires?: null | string;
        max_uses?: null | number;
        server: string;
        type: "Server";
        uses: number;
    }
    _id: string
    Description
    Invite code
    
    channel: string
    Description
    Id of the server channel this invite points to
    
    creator: string
    Description
    Id of user who created this invite
    
    Optionalexpires?: null | string
    Description
    Timestamp at which this invite expires
    
    Optionalmax_uses?: null | number
    Format: uint64
    
    Description
    Maximum number of times this invite can be used
    
    server: string
    Description
    Id of the server this invite points to
    
    type: "Server"
    uses: number
    Format: uint64
    
    Description
    Number of times this invite has been used
  - {
        _id: string;
        channel: string;
        creator: string;
        expires?: null | string;
        max_uses?: null | number;
        type: "Group";
        uses: number;
    }
    _id: string
    Description
    Invite code
    
    channel: string
    Description
    Id of the group channel this invite points to
    
    creator: string
    Description
    Id of user who created this invite
    
    Optionalexpires?: null | string
    Description
    Timestamp at which this invite expires
    
    Optionalmax_uses?: null | number
    Format: uint64
    
    Description
    Maximum number of times this invite can be used
    
    type: "Group"
    uses: number
    Format: uint64
    
    Description
    Number of times this invite has been used
Returns ChannelInvite
Invite
Inherited from ChannelInvite.from
- Defined in src/classes/Invite.ts:32

Class ServerInvite

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_id: string

Description

channel: string

Description

creator: string

Description

Optionalexpires?: null | string

Description

Optionalmax_uses?: null | number

Description

server: string

Description

type: "Server"

uses: number

Description

_id: string

Description

channel: string

Description

creator: string

Description

Optionalexpires?: null | string

Description

Optionalmax_uses?: null | number

Description

type: "Group"

uses: number

Description

type: "Server"

Returns ServerInvite

Properties

ReadonlychannelId

Protected Optionalclient

ReadonlycreatorId

Optional Readonlyexpires

Readonlyid

Optional ReadonlymaxUses

ReadonlyserverId

Readonlytype

Optional Readonlyuses

Accessors

channel

Returns undefined | Channel

creator

Returns undefined | User

server

Returns undefined | Server

Methods

delete

Returns Promise<void>

Staticfrom

Parameters

_id: string

Description

channel: string

Description

creator: string

Description

Optionalexpires?: null | string

Description

Optionalmax_uses?: null | number

Description

server: string

Description

type: "Server"

uses: number

Description

_id: string

Description

channel: string

`Optional`expires?: null | string

`Optional`max_uses?: null | number

`Optional`expires?: null | string

`Optional`max_uses?: null | number

`Readonly`channelId

`Protected` `Optional`client

`Readonly`creatorId

`Optional` `Readonly`expires

`Readonly`id

`Optional` `Readonly`maxUses

`Readonly`serverId

`Readonly`type

`Optional` `Readonly`uses

`Static`from

`Optional`expires?: null | string

`Optional`max_uses?: null | number

`Optional`expires?: null | string

`Optional`max_uses?: null | number