APIInviteChannel

A channel obtained from fetching an invite.

Hierarchy

• Required<APIPartialChannel>
  • APIInviteChannel

Index

Properties

• icon
• id
• name
• recipients
• type

Properties

optionalicon

icon?: string

Icon hash.

inheritedid

id: string

Inherited from Required.id

The id of the channel

inheritedname

name: null | string

Inherited from Required.name

The name of the channel (1-100 characters)

optionalrecipients

recipients?: Pick<APIUser, username>[]

The invite channel's recipients.

@remarks

Only includes usernames of users.

inheritedtype

type: ChannelType

Inherited from Required.type

The type of the channel

@see

https://discord.com/developers/docs/resources/channel#channel-object-channel-types