Update to docs

This commit is contained in:
hydrabolt
2015-10-27 21:58:05 +00:00
parent 9837823907
commit 6d52b071b1
3 changed files with 11 additions and 4 deletions

View File

@@ -69,6 +69,13 @@ Gets a Message_ from the channel that matches the specified criteria. E.g:
- **key** - a `String` that is the key
- **value** - a `String` that is the value
permissionsOf(user)
~~~~~~~~~~~~~~~~~~~
Gets the EvaluatedPermissions_ of a User in the channel.
- **user** - A User_ or Member_ you want to get the permissions of.
equals(object)
~~~~~~~~~~~~~~

View File

@@ -21,7 +21,7 @@ A `unix timestamp` as a `Number` representing when the message was sent.
mentions
~~~~~~~~
An `Array` of User_ objects that represent the users mentioned in the message.
An `Array` of Member_ and User_ objects that represent the users mentioned in the message. The only way that the User_ objects would exist in the Array is if the message is from a log, where the mentioned users may have left the server afterwards.
everyoneMentioned
~~~~~~~~~~~~~~~~~
@@ -60,7 +60,7 @@ author
**Aliases** : `sender`
The User_ that sent the message.
The Member or User_ that sent the message. May be a User_ if from a log, it depends on whether the sender left the server after sending the message. If received in realtime, always a Member.
attachments
~~~~~~~~~~~

View File

@@ -92,11 +92,11 @@ Gets a Channel_ that matches the specified criteria. E.g:
getMember(key, value)
~~~~~~~~~~~~~~~~~~~~~
Gets a User_ that matches the specified criteria. E.g:
Gets a Member_ that matches the specified criteria. E.g:
.. code-block:: js
bot.getUser("id", 1243987349) // returns a user where user.id === 1243987349
server.getMember("id", 1243987349) // returns a Member where member.id === 1243987349
- **key** - a `String` that is the key
- **value** - a `String` that is the value