GuildMemberVerificationFields
GuildMemberVerificationFields
A class representing fields for guild member verification.
Kind: global class
- GuildMemberVerificationFields
- new GuildMemberVerificationFields(data)
- instance
- static
- .transformFields(fields) ⇒
Object
- .transformFields(fields) ⇒
new GuildMemberVerificationFields(data)
Constructs a new GuildMemberVerificationFields object.
Param | Type | Description |
---|---|---|
data | Object | An object containing the data for the verification fields. |
data.enabled | boolean | Whether or not the verification fields are enabled. |
data.description | string | A description of the verification fields. |
data.fields | Array | An array of objects representing the individual verification fields. |
guildMemberVerificationFields.setEnabled(enabled) ⇒ GuildMemberVerificationFields
Sets whether or not the verification fields are enabled.
Kind: instance method of GuildMemberVerificationFields
Returns: GuildMemberVerificationFields
- The GuildMemberVerificationFields object.
Param | Type | Description |
---|---|---|
enabled | boolean | Whether or not the verification fields are enabled. |
guildMemberVerificationFields.setDescription(description) ⇒ GuildMemberVerificationFields
Sets the description of the verification fields.
Kind: instance method of GuildMemberVerificationFields
Returns: GuildMemberVerificationFields
- The GuildMemberVerificationFields object.
Param | Type | Description |
---|---|---|
description | string | A description of the verification fields. |
guildMemberVerificationFields.setFields(…fields) ⇒ GuildMemberVerificationFields
Sets the verification fields.
Kind: instance method of GuildMemberVerificationFields
Returns: GuildMemberVerificationFields
- The GuildMemberVerificationFields object.
Param | Type | Description |
---|---|---|
…fields | Object | One or more objects representing the individual verification fields. |
guildMemberVerificationFields.addFields(…fields) ⇒ GuildMemberVerificationFields
Adds one or more verification fields.
Kind: instance method of GuildMemberVerificationFields
Returns: GuildMemberVerificationFields
- The GuildMemberVerificationFields object.
Param | Type | Description |
---|---|---|
…fields | Object | One or more objects representing the individual verification fields. |
guildMemberVerificationFields.toJSON() ⇒ Object
Returns the verification fields as a JSON object.
Kind: instance method of GuildMemberVerificationFields
Returns: Object
- The verification fields as a JSON object.
GuildMemberVerificationFields.transformFields(fields) ⇒ Object
Transforms an object representing a verification field into the required format.
Kind: static method of GuildMemberVerificationFields
Returns: Object
- An object representing the verification field in the required format.
Param | Type | Description |
---|---|---|
fields | Object | An object representing a verification field. |