Class Invite

constructor

• new Invite(
      client: client,
      data:
          | {
              _id: string;
              channel: string;
              creator: string;
              server: string;
              type: "Server";
          }
          | { _id: string; channel: string; creator: string; type: "Group" },
  ): Invite

  Creates a new Invite instance.

  Parameters

  • client: client

    The client instance.
  • data:
        | {
            _id: string;
            channel: string;
            creator: string;
            server: string;
            type: "Server";
        }
        | { _id: string; channel: string; creator: string; type: "Group" }

    The raw data for the invite from the API.

    • {
          _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 Invite

channelId

inviterId

serverId

channel

• get channel(): null | Channel

  Retrieves the channel associated with the invite.

  Returns null | Channel

  The channel associated with the invite, or null if not found.

inviter

• get inviter(): null | User

  Retrieves the user who created the invite.

  Returns null | User

  The user who created the invite, or null if not found.

server

• get server(): null | Server

  Retrieves the server associated with the invite.

  Returns null | Server

  The server associated with the invite, or null if not found.