Class ServerInvite

Server Invite

Hierarchy (View Summary)

Constructors

constructor

Properties

channelId client? creatorId id serverId type

Accessors

channel creator server

Methods

delete from

Constructors

constructor

  • new ServerInvite(
        client: Client,
        invite: (
            | {
                _id: string;
                channel: string;
                creator: string;
                server: string;
                type: "Server";
            }
            | { _id: string; channel: string; creator: string; type: "Group" }
        ) & { type: "Server" },
    ): ServerInvite

    Construct Server Invite

    Parameters

    • client: Client

      Client

    • invite: (
          | {
              _id: string;
              channel: string;
              creator: string;
              server: string;
              type: "Server";
          }
          | { _id: string; channel: string; creator: string; type: "Group" }
      ) & { type: "Server" }

      Invite

      • {
            _id: string;
            channel: string;
            creator: string;
            server: string;
            type: "Server";
        }
        • _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

        • server: string

          Description

          Id of the server this invite points to

        • type: "Server"
      • { _id: string; channel: string; creator: string; type: "Group" }
        • _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

        • type: "Group"
      • type: "Server"

    Returns ServerInvite

Properties

ReadonlychannelId

channelId: string

Protected Optionalclient

client?: Client

ReadonlycreatorId

creatorId: string

Readonlyid

id: string

ReadonlyserverId

serverId: string

Readonlytype

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

Accessors

channel

creator

server

Methods

delete

Staticfrom

  • from(
        client: Client,
        invite:
            | {
                _id: string;
                channel: string;
                creator: string;
                server: string;
                type: "Server";
            }
            | { _id: string; channel: string; creator: string; type: "Group" },
    ): 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

      • {
            _id: string;
            channel: string;
            creator: string;
            server: string;
            type: "Server";
        }
        • _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

        • server: string

          Description

          Id of the server this invite points to

        • type: "Server"
      • { _id: string; channel: string; creator: string; type: "Group" }
        • _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

        • type: "Group"

    Returns ChannelInvite

    Invite

On This Page

Constructors
Properties
Accessors
Methods