GuildMemberVerification

GuildMemberVerification ⇐ Base

Represents the verification requirements for a guild member.

Kind: global class
Extends: Base

• GuildMemberVerification ⇐ Base
  • new GuildMemberVerification(data, guildId, client)
  • instance
    • .guild : Guild
    • .fetch([options]) ⇒ Promise.<GuildMemberVerification>
    • .edit([options]) ⇒ Promise.<GuildMemberVerification>
    • .setEnabled(enabled, [reason]) ⇒ Promise.<GuildMemberVerification>
    • .setDescription(description, [reason]) ⇒ Promise.<GuildMemberVerification>
    • .addFields(fields) ⇒ Promise.<GuildMemberVerification>
    • .removeFields() ⇒ Promise.<GuildMemberVerification>
  • static
    • .transformoptions(fields) ⇒ Object

new GuildMemberVerification(data, guildId, client)

Param	Type	Description
data	Object	The data for the verification.
guildId	string	The ID of the guild the verification is for.
client	Client	The client that instantiated this object.

guildMemberVerification.guild : Guild

The guild the verification is for.

Kind: instance property of GuildMemberVerification
Read only: true

guildMemberVerification.fetch([options]) ⇒ Promise.<GuildMemberVerification>

Fetches this verification’s settings.

Kind: instance method of GuildMemberVerification

Param	Type	Description
[options]	BaseFetchOptions	Additional options for the fetch.

guildMemberVerification.edit([options]) ⇒ Promise.<GuildMemberVerification>

Edits this verification’s settings.

Kind: instance method of GuildMemberVerification

Param	Type	Description
[options]	GuildMemberVerificationEditOptions	The options to edit the verification.

guildMemberVerification.setEnabled(enabled, [reason]) ⇒ Promise.<GuildMemberVerification>

Sets whether this verification is enabled.

Kind: instance method of GuildMemberVerification

Param	Type	Description
enabled	boolean	Whether the verification is enabled.
[reason]	string	The reason for the change.

guildMemberVerification.setDescription(description, [reason]) ⇒ Promise.<GuildMemberVerification>

Sets the description for this verification.

Kind: instance method of GuildMemberVerification

Param	Type	Description
description	string	The new description for the verification.
[reason]	string	The reason for the change.

guildMemberVerification.addFields(fields) ⇒ Promise.<GuildMemberVerification>

Adds new fields to this verification.

Kind: instance method of GuildMemberVerification

Param	Type	Description
fields	Array.<VerificationFormFields>	The fields to add to the verification.

guildMemberVerification.removeFields() ⇒ Promise.<GuildMemberVerification>

Removes all fields from this verification.

Kind: instance method of GuildMemberVerification

GuildMemberVerification.transformoptions(fields) ⇒ Object

Transforms options for a verification form field.

Kind: static method of GuildMemberVerification
Returns: Object - The transformed form fields.

Param	Type	Description
fields	Object	The fields to transform.
fields.type	string	The type of the form field.
fields.label	string	The label for the form field.
fields.required	boolean	Whether the field is required or not.
fields.values	Array	The values for the field.
fields.choices	Array	The choices for the field.