WelcomeScreenManager
WelcomeScreenManager ⇐ Base
Represents a manager for the welcome screen of a guild.
Kind: global class
Extends: Base
- WelcomeScreenManager ⇐
Base
- new WelcomeScreenManager(guildId, client)
- instance
- .fetch() ⇒
Promise.<WelcomeScreen>
- .edit([options]) ⇒
Promise.<WelcomeScreen>
- .fetch() ⇒
- static
- .transformChannels(channels) ⇒
Object
- .transformOptions(o) ⇒
Object
- .transformChannels(channels) ⇒
new WelcomeScreenManager(guildId, client)
Constructs a new instance of the class.
Param | Type | Description |
---|---|---|
guildId | string | The ID of the guild. |
client | Client | The client instance. |
welcomeScreenManager.fetch() ⇒ Promise.<WelcomeScreen>
Fetches the welcome screen for the guild.
Kind: instance method of WelcomeScreenManager
Returns: Promise.<WelcomeScreen>
- A promise that resolves to a WelcomeScreen object representing the fetched welcome screen.
welcomeScreenManager.edit([options]) ⇒ Promise.<WelcomeScreen>
Edits the welcome screen settings for the guild.
Kind: instance method of WelcomeScreenManager
Returns: Promise.<WelcomeScreen>
- A promise that resolves with the updated WelcomeScreen object.
Param | Type | Description |
---|---|---|
[options] | Object | The options for editing the welcome screen. |
[options.reason] | string | The reason for the edit. |
WelcomeScreenManager.transformChannels(channels) ⇒ Object
Transforms the given channels object into a new format.
Kind: static method of WelcomeScreenManager
Returns: Object
- - The transformed channels object.
Param | Type | Description |
---|---|---|
channels | Object | The channels object to transform. |
WelcomeScreenManager.transformOptions(o) ⇒ Object
Transforms the options object into a new object with specific properties.
Kind: static method of WelcomeScreenManager
Returns: Object
- - The transformed object with specific properties.
Param | Type | Description |
---|---|---|
o | Object | The options object to transform. |