Documented new additions

This commit is contained in:
hydrabolt
2015-11-21 15:07:32 +00:00
parent 65698cf525
commit 08544d3cd5
4 changed files with 25 additions and 1 deletions

View File

@@ -295,10 +295,24 @@ setStatus(status, `game`, `callback`)
Sets the Discord Status of the Client
- **status** - `String`, either `online` or `idle`
- **status** - `String`, either ``online, here, active, available`` or ``idle, away``
- **game** - `String/Number`, ID of Discord Game being played
- **callback** - `function` taking the following:
- **error** - error if any occurred
setStatusIdle()
~~~~~~~~~~~~~~~
**Alias:** `setStatusAway`
Sets the status of the Client to Idle/Away
setStatusOnline()
~~~~~~~~~~~~~~~
**Aliases:** `setStatusHere`, `setStatusActive`, `setStatusAvailable`
Sets the status of the Client to Online
setTopic(channel, topic, `callback`)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -60,6 +60,8 @@ Timestamp on when the message was last edited, `Number`. Potentially null.
author
~~~~~~
**Alias:** `sender`
The User_ that sent the message.
content

View File

@@ -822,6 +822,10 @@ var Client = (function (_EventEmitter) {
this.setStatusOnline();
};
Client.prototype.setStatusAvailable = function setStatusAvailable() {
this.setStatusOnline();
};
Client.prototype.setStatusAway = function setStatusAway() {
this.setStatusIdle();
};

View File

@@ -813,6 +813,10 @@ class Client extends EventEmitter {
this.setStatusOnline();
}
setStatusAvailable() {
this.setStatusOnline();
}
setStatusAway() {
this.setStatusIdle();
}