GuildDiscovery

GuildDiscovery ⇐ Base

Represents a guild’s discovery metadata.

Kind: global class
Extends: Base

• GuildDiscovery ⇐ Base
  • new GuildDiscovery(data, guildId, client)
  • .partial : boolean
  • .about : string
  • .guildId : Snowflake
  • .categoryIds : Array.<string>
  • .emojiDiscoverabilityEnabled : boolean
  • .published : boolean
  • .keywords : Array.<string>
  • .partnerActionedAt : Date
  • .partnerActionedTimestamp : number
  • .partnerApplicationAt : Date
  • .partnerApplicationTimestamp : number
  • .primaryCategoryId : GuildPrimaryCategory
  • .reasonsToJoin : Array.<string>
  • .socialLinks : Object
  • .guild ⇒ Guild
  • .fetch() ⇒ Promise.<DiscoveryMetadata>
  • .edit() ⇒ Promise.<DiscoveryMetadata>
  • .setEmojiDiscoverabilityEnabled(emojiDiscoverabilityEnabled) ⇒ Promise.<DiscoveryMetadata>
  • .setPublished(emojiDiscoverabilityEnabled) ⇒ Promise.<DiscoveryMetadata>
  • .setAbout(about) ⇒ Promise.<DiscoveryMetadata>
  • .setReasonsToJoin(reasonsToJoin) ⇒ Promise.<Discovery>
  • .setKeywords(keywords) ⇒ Promise.<Discovery>
  • .setPrimaryCategoryId(keywords) ⇒ Promise.<Discovery>

new GuildDiscovery(data, guildId, client)

Param	Type	Description
data	Object	The data for the guild discovery metadata
guildId	Snowflake	The ID of the guild this discovery metadata belongs to
client	Client	The instantiating client

guildDiscovery.partial : boolean

Whether or not this guild discovery object is partial.

Kind: instance property of GuildDiscovery

guildDiscovery.about : string

The about section of the guild discovery.

Kind: instance property of GuildDiscovery

guildDiscovery.guildId : Snowflake

The ID of the guild.

Kind: instance property of GuildDiscovery

guildDiscovery.categoryIds : Array.<string>

The category IDs of the guild discovery.

Kind: instance property of GuildDiscovery

guildDiscovery.emojiDiscoverabilityEnabled : boolean

Whether or not emoji discoverability is enabled.

Kind: instance property of GuildDiscovery

guildDiscovery.published : boolean

Whether or not the guild discovery is published.

Kind: instance property of GuildDiscovery

guildDiscovery.keywords : Array.<string>

The keywords associated with the guild discovery.

Kind: instance property of GuildDiscovery

guildDiscovery.partnerActionedAt : Date

The date the guild was partner actioned.

Kind: instance property of GuildDiscovery

guildDiscovery.partnerActionedTimestamp : number

The timestamp of when the guild was partner actioned.

Kind: instance property of GuildDiscovery

guildDiscovery.partnerApplicationAt : Date

The date the guild applied for partnership.

Kind: instance property of GuildDiscovery

guildDiscovery.partnerApplicationTimestamp : number

The timestamp of when the guild applied for partnership.

Kind: instance property of GuildDiscovery

guildDiscovery.primaryCategoryId : GuildPrimaryCategory

The primary category ID of the guild discovery.

Kind: instance property of GuildDiscovery

guildDiscovery.reasonsToJoin : Array.<string>

The reasons to join the guild.

Kind: instance property of GuildDiscovery

guildDiscovery.socialLinks : Object

The social links associated with the guild discovery.

Kind: instance property of GuildDiscovery

guildDiscovery.guild ⇒ Guild

Returns the guild associated with this discovery metadata.

Kind: instance property of GuildDiscovery
Returns: Guild - The guild object.

guildDiscovery.fetch() ⇒ Promise.<DiscoveryMetadata>

Fetches the discovery metadata for the guild.

Kind: instance method of GuildDiscovery
Returns: Promise.<DiscoveryMetadata> - A promise that resolves with the discovery metadata object.

guildDiscovery.edit() ⇒ Promise.<DiscoveryMetadata>

Fetches the discovery metadata for the guild.

Kind: instance method of GuildDiscovery
Returns: Promise.<DiscoveryMetadata> - A promise that resolves with the discovery metadata object.

guildDiscovery.setEmojiDiscoverabilityEnabled(emojiDiscoverabilityEnabled) ⇒ Promise.<DiscoveryMetadata>

Sets whether the emoji discoverability is enabled for the guild.

Kind: instance method of GuildDiscovery
Returns: Promise.<DiscoveryMetadata> - A promise that resolves with the updated discovery metadata object.

Param	Type	Description
emojiDiscoverabilityEnabled	boolean	A boolean indicating whether the emoji discoverability is enabled.

guildDiscovery.setPublished(emojiDiscoverabilityEnabled) ⇒ Promise.<DiscoveryMetadata>

Sets whether the emoji discoverability is enabled for the guild.

Kind: instance method of GuildDiscovery
Returns: Promise.<DiscoveryMetadata> - A promise that resolves with the updated discovery metadata object.

Param	Type	Description
emojiDiscoverabilityEnabled	boolean	A boolean indicating whether the emoji discoverability is enabled.

guildDiscovery.setAbout(about) ⇒ Promise.<DiscoveryMetadata>

Sets the description of the guild for the discovery page.

Kind: instance method of GuildDiscovery
Returns: Promise.<DiscoveryMetadata> - A promise that resolves with the updated discovery metadata object.

Param	Type	Description
about	string	The description of the guild.

guildDiscovery.setReasonsToJoin(reasonsToJoin) ⇒ Promise.<Discovery>

Sets the “Reasons to Join” section for the associated guild in the discovery settings.

Kind: instance method of GuildDiscovery
Returns: Promise.<Discovery> - The updated discovery object.

Param	Type	Description
reasonsToJoin	string	The new “Reasons to Join” section content.

guildDiscovery.setKeywords(keywords) ⇒ Promise.<Discovery>

Sets the keywords associated with the associated guild in the discovery settings.

Kind: instance method of GuildDiscovery
Returns: Promise.<Discovery> - The updated discovery object.

Param	Type	Description
keywords	Array.<string>	The new keywords.

guildDiscovery.setPrimaryCategoryId(keywords) ⇒ Promise.<Discovery>

Sets the keywords associated with the associated guild in the discovery settings.

Kind: instance method of GuildDiscovery
Returns: Promise.<Discovery> - The updated discovery object.

Param	Type	Description
keywords	Array.<string>	The new keywords.