GuildMemberVerificationManager
GuildMemberVerificationManager ⇐ Base
Represents a manager for guild member verification settings.
Kind: global class
Extends: Base
- GuildMemberVerificationManager ⇐
Base
- new GuildMemberVerificationManager(guildId, client)
- instance
- .fetch([options]) ⇒
Promise.<GuildMemberVerification>
- .edit([options]) ⇒
Promise.<GuildMemberVerification>
- .fetch([options]) ⇒
- static
- .createFormFields(fields) ⇒
Object
- .createFormFields(fields) ⇒
new GuildMemberVerificationManager(guildId, client)
Constructs a new instance of the class.
Param | Type | Description |
---|---|---|
guildId | string | The ID of the guild. |
client | Client | The client instance. |
guildMemberVerificationManager.fetch([options]) ⇒ Promise.<GuildMemberVerification>
Fetches the member verification information for a guild.
Kind: instance method of GuildMemberVerificationManager
Returns: Promise.<GuildMemberVerification>
- - A promise that resolves with the fetched GuildMemberVerification object.
Param | Type | Description |
---|---|---|
[options] | Object | The options for the fetch request. |
[options.withGuild] | boolean | Whether to include guild information in the response. |
[options.inviteCode] | string | Object | The invite code or object containing the invite code. |
guildMemberVerificationManager.edit([options]) ⇒ Promise.<GuildMemberVerification>
Edits the member verification settings for the guild.
Kind: instance method of GuildMemberVerificationManager
Returns: Promise.<GuildMemberVerification>
- A promise that resolves with the updated GuildMemberVerification object.
Param | Type | Description |
---|---|---|
[options] | Object | The options for the member verification settings. |
[options.enabled] | boolean | Whether member verification is enabled or not. |
[options.fields] | Array.<Object> | An array of form field objects for member verification. |
[options.description] | string | The description for the member verification form. |
GuildMemberVerificationManager.createFormFields(fields) ⇒ Object
Creates a form field object with the given fields.
Kind: static method of GuildMemberVerificationManager
Returns: Object
- - The created form field object.
Param | Type | Description |
---|---|---|
fields | Object | The fields to include in the form field object. |