Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Invite<T>

Type parameters

  • T

Hierarchy

Index

Constructors

constructor

Properties

approximateMemberCount

approximateMemberCount: number | null

Approximate count of total members.

since

0.0.1

approximatePresenceCount

approximatePresenceCount: number | null

Approximate count of online members (only present when target_user is set).

since

0.0.1

Readonly channel

channel: Channel

The channel this invite is for.

since

0.0.1

Readonly client

client: T

Readonly guild

guild: Guild | null

The guild this invite is for.

since

0.0.1

Readonly id

id: string

The invite code.

since

0.0.1

inviter

inviter: User | null

The user who created the invite.

since

0.0.1

targetUser

targetUser: User | null

The target user for this invite.

since

0.0.1

targetUserType

targetUserType: InviteTargetUserType | null

The type of user target for this invite.

since

0.0.1

see

https://discord.com/developers/docs/resources/invite#invite-object-target-user-types

Accessors

createdAt

  • get createdAt(): Date

createdTimestamp

  • get createdTimestamp(): number

Methods

Protected _patch

  • _patch(data: APIInviteData): this

clone

  • clone(): this

toJSON

  • toJSON(): Record<string, any>

valueOf

  • valueOf(): string

Generated using TypeDoc