Invite
Invite ⇐ Base
Represents an invite to a guild.
Kind: global class
Extends: Base
- Invite ⇐
Base
- new Invite([data], guild, client)
- .fetch(options) ⇒
Promise
- .delete(reason) ⇒
Promise.<void>
new Invite([data], guild, client)
Constructs a new instance of the Invite class.
Param | Type | Description |
---|---|---|
[data] | Object | The data for the invite. |
guild | Guild | The guild that the invite belongs to. |
client | Client | The client instance. |
invite.fetch(options) ⇒ Promise
Fetches an invite using the provided options.
Kind: instance method of Invite
Returns: Promise
- A promise that resolves to the fetched invite.
Param | Type | Description |
---|---|---|
options | object | The options for fetching the invite. |
invite.delete(reason) ⇒ Promise.<void>
Deletes the invite associated with the guild.
Kind: instance method of Invite
Returns: Promise.<void>
- - A promise that resolves when the invite is deleted.
Param | Type | Description |
---|---|---|
reason | string | The reason for deleting the invite. |