Interface InviteWithMetadata<CH>

Represents an invite.

interface InviteWithMetadata<CH> {
    approximateMemberCount: undefined;
    approximatePresenceCount: undefined;
    channelID: null | string;
    client: Client<ClientEvents>;
    code: string;
    createdAt: Date;
    expiresAt?: Date;
    flags: number;
    guild: null | InviteGuild;
    guildID: null | string;
    guildScheduledEvent: undefined;
    inviter?: User;
    maxAge: number;
    maxUses: number;
    roles?: InviteRole[];
    stageInstance?: InviteStageInstance;
    targetApplication?: PartialApplication;
    targetType?: InviteTargetTypes;
    targetUser?: User;
    temporary: boolean;
    type: InviteTypes;
    uses: number;
    get channel(): null | (CH extends AnyInviteChannel
        ? CH<CH>
        : PartialInviteChannel);
    deleteInvite(reason?): Promise<Invite<CH>>;
    getTargetUsers(): Promise<string[]>;
    getTargetUsersJobStatus(): Promise<InviteTargetUsersJobStatusResponse>;
    inCachedChannel(): this is Invite<AnyInviteChannel>;
    inCachedGuildChannel(): this is Invite<AnyGuildInviteChannel>;
    inDMChannel(): this is Invite<never>;
    toJSON(): JSONInvite;
    updateInviteTargetUsers(users): Promise<null>;
}

Type Parameters

CH extends GuildInviteChannel = GuildInviteChannel

Hierarchy (view full)

Invite<CH>
- InviteWithMetadata

Properties

approximateMemberCount

approximateMemberCount: undefined

The approximate number of total members in the guild this invite leads to.

approximatePresenceCount

approximatePresenceCount: undefined

The approximate number of online members in the guild this invite leads to.

channelID

channelID: null | string

The ID of the channel this invite leads to.

client

client: Client<ClientEvents>

code

code: string

The code of this invite.

createdAt

createdAt: Date

When this invite was created.

`Optional` expiresAt

expiresAt?: Date

The date at which this invite expires.

flags

flags: number

This invite's flags.

guild

guild: null | InviteGuild

The guild this invite leads to or null if this invite leads to a Group DM.

guildID

guildID: null | string

The ID of the guild this invite leads to or null if this invite leads to a Group DM.

guildScheduledEvent

guildScheduledEvent: undefined

The scheduled event associated with this invite.

`Optional` inviter

inviter?: User

The user that created this invite.

maxAge

maxAge: number

The time after which this invite expires.

maxUses

maxUses: number

The maximum number of times this invite can be used,

`Optional` roles

roles?: InviteRole[]

The roles assigned to the user upon accepting the invite .

`Optional` stageInstance

stageInstance?: InviteStageInstance

Deprecated

The stage instance in the invite this channel is for.

`Optional` targetApplication

targetApplication?: PartialApplication

The embedded application this invite will open.

`Optional` targetType

targetType?: InviteTargetTypes

The target type of this invite.

`Optional` targetUser

targetUser?: User

The user whose stream to display for this voice channel stream invite.

temporary

temporary: boolean

If this invite only grants temporary membership.

type

type: InviteTypes

The type of this invite.

uses

uses: number

The number of times this invite has been used.

Accessors

channel

get channel(): null | (CH extends AnyInviteChannel
? CH<CH>
: PartialInviteChannel)
The channel this invite leads to. If the channel is not cached, this will be a partial with only id, name, and type.

Returns null | (CH extends AnyInviteChannel
? CH<CH>
: PartialInviteChannel)
Inherited from Invite.channel
- Defined in lib/structures/Invite.ts:176

Methods

deleteInvite

deleteInvite(reason?): Promise<Invite<CH>>
Delete this invite.
Parameters
- Optional reason: string
  The reason for deleting this invite.
Returns Promise<Invite<CH>>
Inherited from Invite.deleteInvite
- Defined in lib/structures/Invite.ts:194

getTargetUsers

getTargetUsers(): Promise<string[]>
Get the target users for this invite. Requires being the inviter or having the MANAGE_GUILD or VIEW_AUDIT_LOG permission.

Returns Promise<string[]>
Inherited from Invite.getTargetUsers
- Defined in lib/structures/Invite.ts:199

getTargetUsersJobStatus

getTargetUsersJobStatus(): Promise<InviteTargetUsersJobStatusResponse>
et the target users job status for this invite. Requires being the inviter or having the MANAGE_GUILD or VIEW_AUDIT_LOG permission.

Returns Promise<InviteTargetUsersJobStatusResponse>
Inherited from Invite.getTargetUsersJobStatus
- Defined in lib/structures/Invite.ts:204

inCachedChannel

inCachedChannel(): this is Invite<AnyInviteChannel>
Whether this invite belongs to a cached channel. The only difference on using this method over a simple if statement is to easily update all the invite properties typing definitions based on the channel it belongs to.

Returns this is Invite<AnyInviteChannel>
Inherited from Invite.inCachedChannel
- Defined in lib/structures/Invite.ts:209

inCachedGuildChannel

inCachedGuildChannel(): this is Invite<AnyGuildInviteChannel>
Returns this is Invite<AnyGuildInviteChannel>
Inherited from Invite.inCachedGuildChannel
- Defined in lib/structures/Invite.ts:213

inDMChannel

inDMChannel(): this is Invite<never>
Returns this is Invite<never>
Inherited from Invite.inDMChannel
- Defined in lib/structures/Invite.ts:217

toJSON

toJSON(): JSONInvite
Returns JSONInvite
Inherited from Invite.toJSON
- Defined in lib/structures/Invite.ts:221

updateInviteTargetUsers

updateInviteTargetUsers(users): Promise<null>
Update the target users for this invite. Requires being the inviter or having the MANAGE_GUILD permission.
Parameters
- users: string[]
  The IDs of the users to allow accepting the invite.
Returns Promise<null>
Inherited from Invite.updateInviteTargetUsers
- Defined in lib/structures/Invite.ts:254

Interface InviteWithMetadata<CH>

Type Parameters

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

approximateMemberCount

approximatePresenceCount

channelID

client

code

createdAt

Optional expiresAt

flags

guild

guildID

guildScheduledEvent

Optional inviter

maxAge

maxUses

Optional roles

Optional stageInstance

Deprecated

Optional targetApplication

Optional targetType

Optional targetUser

temporary

type

uses

Accessors

channel

Returns null | (CH extends AnyInviteChannel ? CH<CH> : PartialInviteChannel)

Methods

deleteInvite

Parameters

Returns Promise<Invite<CH>>

getTargetUsers

Returns Promise<string[]>

getTargetUsersJobStatus

Returns Promise<InviteTargetUsersJobStatusResponse>

inCachedChannel

Returns this is Invite<AnyInviteChannel>

inCachedGuildChannel

Returns this is Invite<AnyGuildInviteChannel>

inDMChannel

Returns this is Invite<never>

toJSON

Returns JSONInvite

updateInviteTargetUsers

Parameters

Returns Promise<null>

Settings

Member Visibility

Theme

On This Page

`Optional` expiresAt

`Optional` inviter

`Optional` roles

`Optional` stageInstance

`Optional` targetApplication

`Optional` targetType

`Optional` targetUser

Returns null | (CH extends AnyInviteChannel
? CH<CH>
: PartialInviteChannel)