discord.js/src/structures/PermissionOverwrites.js
Schuyler Cebulskie 27652b94af Make JSDocs follow general conventions (#582)
* Make JSDocs follow usual conventions

* Fix StringResolvable name

* Make function lowercase
2016-09-03 09:57:25 +01:00

40 lines
874 B
JavaScript

/**
* Represents a permission overwrite for a Role or Member in a Guild Channel.
*/
class PermissionOverwrites {
constructor(guildChannel, data) {
/**
* The GuildChannel this overwrite is for
* @type {GuildChannel}
*/
this.channel = guildChannel;
if (data) {
this.setup(data);
}
}
setup(data) {
/**
* The type of this overwrite
* @type {string}
*/
this.type = data.type;
/**
* The ID of this overwrite, either a User ID or a Role ID
* @type {string}
*/
this.id = data.id;
this.denyData = data.deny;
this.allowData = data.allow;
}
/**
* Delete this Permission Overwrite.
* @returns {Promise<PermissionOverwrites, Error>}
*/
delete() {
return this.channel.client.rest.methods.deletePermissionOverwrites(this);
}
}
module.exports = PermissionOverwrites;