Mercurial > prosody-wiki
comparison mod_roster_command.wiki @ 227:e661e843f083
Created wiki page through web user interface.
| author | MWild1 |
|---|---|
| date | Tue, 11 Oct 2011 00:58:27 +0000 |
| parents | |
| children | 9ab5744a0afa |
comparison
equal
deleted
inserted
replaced
| 226:b5e2876a6320 | 227:e661e843f083 |
|---|---|
| 1 #summary Manage rosters through prosodyctl | |
| 2 #labels Stage-Beta | |
| 3 | |
| 4 = Introduction = | |
| 5 | |
| 6 This module allows you to perform various actions on user rosters via prosodyctl. | |
| 7 | |
| 8 = Details = | |
| 9 | |
| 10 After putting this module in your modules directory you can use it via prosodyctl like this: | |
| 11 | |
| 12 {{{ | |
| 13 prosodyctl mod_roster_command COMMAND [OPTIONS...] | |
| 14 }}} | |
| 15 | |
| 16 == Commands == | |
| 17 | |
| 18 {{{ | |
| 19 subscribe user@host contact@host | |
| 20 }}} | |
| 21 | |
| 22 Subscribes the user to the contact's presence. That is, the user will see when the contact is online (but the contact won't see the user). | |
| 23 | |
| 24 {{{ | |
| 25 subscribe_both user@host contact@host | |
| 26 }}} | |
| 27 The same as the 'subscribe' command, but performs the subscription in both directions, so that both the contact and user will always see each other online. | |
| 28 | |
| 29 {{{ | |
| 30 unsubscribe user@host contact@host | |
| 31 }}} | |
| 32 | |
| 33 Removes a subscription to the contact's presence. | |
| 34 | |
| 35 {{{ | |
| 36 unsubscribe_both user@host contact@host | |
| 37 }}} | |
| 38 | |
| 39 Same as unsubscribe, but also revokes a contact's subscription to the user's presence. | |
| 40 | |
| 41 {{{ | |
| 42 rename user@host contact@host [name] [group] | |
| 43 }}} | |
| 44 | |
| 45 Sets or updates a name for a contact in the user's roster, and moves the contact to the given group, if specified. | |
| 46 | |
| 47 = Compatibility = | |
| 48 || 0.8 || Works || | |
| 49 || 0.7 || Should work || |