Class ServerPublicInvite

Public Server Invite

Hierarchy (View Summary)

PublicChannelInvite
- ServerPublicInvite

Index

Constructors

Properties

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

Methods

join from

Constructors

constructor

new ServerPublicInvite(
    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;
        }
    ) & { type: "Server" },
): ServerPublicInvite
Construct Server 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;
      }
  ) & { type: "Server" }
  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;
    }
    Optionalchannel_description?: null | string
    Description
    Description of server channel
    
    channel_id: string
    Description
    Id of server channel
    
    channel_name: string
    Description
    Name of server channel
    
    code: string
    Description
    Invite code
    
    member_count: number
    Format: int64
    
    Description
    Number of members in this server
    
    Optionalserver_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;
        }
    Description
    Attachment for server banner
    
    Optionalserver_flags?: null | number
    Format: int32
    
    Description
    Enum of server flags
    
    Optionalserver_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;
        }
    Description
    Attachment for server icon
    
    server_id: string
    Description
    Id of the server
    
    server_name: string
    Description
    Name of the server
    
    type: "Server"
    Optionaluser_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;
        }
    Description
    Avatar of the user who created the invite
    
    user_name: string
    Description
    Name of user who created the invite
  - {
        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;
    }
    Optionalchannel_description?: null | string
    Description
    Description of group channel
    
    channel_id: string
    Description
    Id of group channel
    
    channel_name: string
    Description
    Name of group channel
    
    code: string
    Description
    Invite code
    
    type: "Group"
    Optionaluser_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;
        }
    Description
    Avatar of the user who created the invite
    
    user_name: string
    Description
    Name of user who created the invite
  - type: "Server"
Returns ServerPublicInvite
Overrides PublicChannelInvite.constructor
- Defined in src/classes/PublicInvite.ts:73

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: "Group" | "Server" | "None"

`Optional` `Readonly`userAvatar

userAvatar?: File

`Readonly`userName

userName: string

Methods

join

join(): Promise<Server>
Join the server

Returns Promise<Server>
- Defined in src/classes/PublicInvite.ts:101

`Static`from

from(
    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;
        },
): PublicChannelInvite
Create an Invite from an API Invite Response
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
  - {
        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;
    }
    Optionalchannel_description?: null | string
    Description
    Description of server channel
    
    channel_id: string
    Description
    Id of server channel
    
    channel_name: string
    Description
    Name of server channel
    
    code: string
    Description
    Invite code
    
    member_count: number
    Format: int64
    
    Description
    Number of members in this server
    
    Optionalserver_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;
        }
    Description
    Attachment for server banner
    
    Optionalserver_flags?: null | number
    Format: int32
    
    Description
    Enum of server flags
    
    Optionalserver_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;
        }
    Description
    Attachment for server icon
    
    server_id: string
    Description
    Id of the server
    
    server_name: string
    Description
    Name of the server
    
    type: "Server"
    Optionaluser_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;
        }
    Description
    Avatar of the user who created the invite
    
    user_name: string
    Description
    Name of user who created the invite
  - {
        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;
    }
    Optionalchannel_description?: null | string
    Description
    Description of group channel
    
    channel_id: string
    Description
    Id of group channel
    
    channel_name: string
    Description
    Name of group channel
    
    code: string
    Description
    Invite code
    
    type: "Group"
    Optionaluser_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;
        }
    Description
    Avatar of the user who created the invite
    
    user_name: string
    Description
    Name of user who created the invite
Returns PublicChannelInvite
Invite
Inherited from PublicChannelInvite.from
- Defined in src/classes/PublicInvite.ts:34

Class ServerPublicInvite

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optionalchannel_description?: null | string

Description

channel_id: string

Description

channel_name: string

Description

code: string

Description

member_count: number

Description

Description

Optionalserver_flags?: null | number

Description

Description

server_id: string

Description

server_name: string

Description

type: "Server"

Description

user_name: string

Description

Optionalchannel_description?: null | string

Description

channel_id: string

Description

channel_name: string

Description

code: string

Description

type: "Group"

Description

user_name: string

Description

type: "Server"

Returns ServerPublicInvite

Properties

Optional ReadonlychannelDescription

ReadonlychannelId

ReadonlychannelName

Protected Optionalclient

Readonlycode

ReadonlymemberCount

Optional ReadonlyserverBanner

ReadonlyserverFlags

Optional ReadonlyserverIcon

ReadonlyserverId

ReadonlyserverName

Readonlytype

Optional ReadonlyuserAvatar

ReadonlyuserName

Methods

join

Returns Promise<Server>

Staticfrom

Parameters

Optionalchannel_description?: null | string

Description

channel_id: string

Description

channel_name: string

Description

code: string

Description

member_count: number

Description

Description

Optionalserver_flags?: null | number

Description

Description

server_id: string

`Optional`channel_description?: null | string

`Optional`server_flags?: null | number

`Optional`channel_description?: null | string

`Optional` `Readonly`channelDescription

`Readonly`channelId

`Readonly`channelName

`Protected` `Optional`client

`Readonly`code

`Readonly`memberCount

`Optional` `Readonly`serverBanner

`Readonly`serverFlags

`Optional` `Readonly`serverIcon

`Readonly`serverId

`Readonly`serverName

`Readonly`type

`Optional` `Readonly`userAvatar

`Readonly`userName

`Static`from

`Optional`channel_description?: null | string

`Optional`server_flags?: null | number

`Optional`channel_description?: null | string