Skip to content

feat(ClientUser): Add support for setting bot banner #10176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 9, 2024
Merged

feat(ClientUser): Add support for setting bot banner #10176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d81765
feat(discord.js): added support to setting bot banner
MinerPL Mar 14, 2024
d802e33
fix: resolve requested changes
MinerPL Mar 15, 2024
5eae123
fix: add missing type in ClientUserEditOptions
MinerPL Mar 15, 2024
332eaa8
Merge branch 'main' into discord.js/bot-banner
Jiralite Apr 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions packages/discord.js/src/structures/ClientUser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,21 @@ class ClientUser extends User {
* @typedef {Object} ClientUserEditOptions
* @property {string} [username] The new username
* @property {?(BufferResolvable|Base64Resolvable)} [avatar] The new avatar
* @property {?(BufferResolvable|Base64Resolvable)} [banner] The new banner
*/

/**
* Edits the logged in client.
* @param {ClientUserEditOptions} options The options to provide
* @returns {Promise<ClientUser>}
*/
async edit({ username, avatar }) {
async edit({ username, avatar, banner }) {
const data = await this.client.rest.patch(Routes.user(), {
body: { username, avatar: avatar && (await resolveImage(avatar)) },
body: {
username,
avatar: avatar && (await resolveImage(avatar)),
banner: banner && (await resolveImage(banner)),
},
});

this.client.token = data.token;
Expand Down Expand Up @@ -95,6 +100,20 @@ class ClientUser extends User {
return this.edit({ avatar });
}

/**
* Sets the banner of the logged in client.
* @param {?(BufferResolvable|Base64Resolvable)} banner The new banner
* @returns {Promise<ClientUser>}
* @example
* // Set banner
* client.user.setBanner('./banner.png')
* .then(user => console.log(`New banner set!`))
* .catch(console.error);
*/
setBanner(banner) {
return this.edit({ banner });
}

/**
* Options for setting activities
* @typedef {Object} ActivitiesOptions
Expand Down
2 changes: 2 additions & 0 deletions packages/discord.js/typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1093,6 +1093,7 @@ export class ClientUser extends User {
public setActivity(name: string, options?: Omit<ActivityOptions, 'name'>): ClientPresence;
public setAFK(afk?: boolean, shardId?: number | readonly number[]): ClientPresence;
public setAvatar(avatar: BufferResolvable | Base64Resolvable | null): Promise<this>;
public setBanner(banner: BufferResolvable | Base64Resolvable | null): Promise<this>;
public setPresence(data: PresenceData): ClientPresence;
public setStatus(status: PresenceStatusData, shardId?: number | readonly number[]): ClientPresence;
public setUsername(username: string): Promise<this>;
Expand Down Expand Up @@ -5233,6 +5234,7 @@ export interface ClientPresenceStatusData {
export interface ClientUserEditOptions {
username?: string;
avatar?: BufferResolvable | Base64Resolvable | null;
banner?: BufferResolvable | Base64Resolvable | null;
}

export interface CloseEvent {
Expand Down