Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update api and examples with muteUser, unmuteUser and listMutedUsers

  • Loading branch information...
commit f9237791580f0654de5aabf3db8ae15608c1a2c2 1 parent 05f6dd7
Damien Klinnert authored
Showing with 61 additions and 0 deletions.
  1. +61 −0 README.md
61 README.md
View
@@ -121,6 +121,39 @@ errorClient.listFollowers(config.user_id, function (err, users) {
});
```
+### object.muteUser()
+returns a user object.
+
+```js
+client.muteUser(config.user_id, function (err, user) {
+ should.exist(user);
+ should.not.exist(err);
+ done();
+});
+```
+
+### object.unmuteUser()
+returns a user object.
+
+```js
+client.unmuteUser(config.user_id, function (err, user) {
+ should.exist(user);
+ should.not.exist(err);
+ done();
+});
+```
+
+### object.listMutedUsers()
+returns user objects.
+
+```js
+client.listMutedUsers(config.user_id, function (err, users) {
+ should.exist(users);
+ should.not.exist(err);
+ done();
+});
+```
+
#### object.checkToken()
returns an auth object.
@@ -343,6 +376,34 @@ List users following a user with the given `id` and callback `cb(err, users)`.
* **Function** *cb*
+### muteUser(id, cb)
+
+Mute a user with the given `id` and callback `cb(err, user)`.
+
+#### Params:
+
+* **String** *id* of the user
+
+* **Function** *cb*
+
+### unmuteUser(id, cb)
+
+Unmute a user with the given `id` and callback `cb(err, user)`.
+
+#### Params:
+
+* **String** *id* of the user
+
+* **Function** *cb*
+
+### listMutedUsers(cb)
+
+List muted users and callback `cb(err, user)`.
+
+#### Params:
+
+* **Function** *cb*
+
### object.checkToken(cb)
Check current access token and callback `cb(err, auth)`.
Please sign in to comment.
Something went wrong with that request. Please try again.