Class ServerPublicInvite

Public Server Invite

Hierarchy

Constructors

constructor

Properties

channelDescription? channelId channelName client? code memberCount serverBanner? serverFlags serverIcon? serverId serverName type userAvatar? userName

Methods

join from

Constructors

constructor

Properties

Optional Readonly channelDescription

channelDescription?: string

Readonly channelId

channelId: string

Readonly channelName

channelName: string

Protected Optional client

client?: Client

Readonly code

code: string

Readonly memberCount

memberCount: number

Optional Readonly serverBanner

serverBanner?: File

Readonly serverFlags

serverFlags: ServerFlags

Optional Readonly serverIcon

serverIcon?: File

Readonly serverId

serverId: string

Readonly serverName

serverName: string

Readonly type

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

Optional Readonly userAvatar

userAvatar?: File

Readonly userName

userName: string

Methods

join

Static from

  • Create an Invite from an API Invite Response

    Returns

    Invite

    Parameters

    • client: Client

      Client

    • invite: {
          channel_description?: null | string;
          channel_id: string;
          channel_name: string;
          code: string;
          member_count: number;
          server_banner?: null | {
              _id: string;
              content_type: string;
              deleted?: null | boolean;
              filename: string;
              message_id?: null | string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          };
          server_flags?: null | number;
          server_icon?: null | {
              _id: string;
              content_type: string;
              deleted?: null | boolean;
              filename: string;
              message_id?: null | string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          };
          server_id: string;
          server_name: string;
          type: "Server";
          user_avatar?: null | {
              _id: string;
              content_type: string;
              deleted?: null | boolean;
              filename: string;
              message_id?: null | string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          };
          user_name: string;
      } | {
          channel_description?: null | string;
          channel_id: string;
          channel_name: string;
          code: string;
          type: "Group";
          user_avatar?: null | {
              _id: string;
              content_type: string;
              deleted?: null | boolean;
              filename: string;
              message_id?: null | string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          };
          user_name: string;
      }

      Data

    Returns PublicChannelInvite

On This Page

Generated using TypeDoc