Add setNickname docs

This commit is contained in:
abalabahaha
2016-04-30 11:58:12 -07:00
parent 249b6f919a
commit e48f2ffae3
4 changed files with 28 additions and 0 deletions

View File

@@ -702,6 +702,17 @@ Server-undeafens a member.
- **callback** - `function` taking the following:
- **error** - error if any occurred.
setNickname(server, nickname, `user`, `callback`)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Set the nickname of a user on a server.
- **server** - A `Server Resolvable`_ to set the nickname of the user in
- **nickname** - `string` of the nickname
- **user** - The `User Resolvable`_ to perform the nickname change on. If no user is specified, this will change the bot user's nickname
- **callback** - `function` taking the following:
- **error** - error if any occurred.
Events
------

View File

@@ -166,6 +166,12 @@ kickMember(user, `callback`)
| **Aliases** `kickUser, kick`
| **See** client.kickMember_
setNickname(nickname, user, `callback`)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| **Shortcut of** ``client.setNickname(server, nickname, user, callback)``
| **See** client.setNickname_
.. _client.leaveServer : ./docs_client.html#leaveserver-server-callback
.. _client.createInvite : ./docs_client.html#createinvite-channel-options-callback
.. _client.createRole : ./docs_client.html#createrole-server-data-callback
@@ -173,4 +179,5 @@ kickMember(user, `callback`)
.. _client.banMember : ./docs_client.html#banmember-user-server-length-callback
.. _client.unbanMember : ./docs_client.html#unbanmember-user-server-callback
.. _client.kickMember : ./docs_client.html#kickmember-user-server-callback
.. _client.setNickname : ./docs_client.html#setNickname-server-nickname-user-callback
.. _client.getBans : ./docs_client.html#getbans-server-callback

View File

@@ -755,6 +755,11 @@ var Client = (function (_EventEmitter) {
Client.prototype.setNickname = function setNickname(server, nick, user) {
var callback = arguments.length <= 3 || arguments[3] === undefined ? function () /*err, {}*/{} : arguments[3];
if (typeof user === "function") {
// user is the callback
callback = user;
user = null;
}
if (!user) {
user = this.user;
}

View File

@@ -812,6 +812,11 @@ export default class Client extends EventEmitter {
// def setNickname
setNickname(server, nick, user, callback = (/*err, {}*/) => { }) {
if (typeof user === "function") {
// user is the callback
callback = user;
user = null;
}
if(!user) {
user = this.user;
}