annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
227
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
1 #summary Manage rosters through prosodyctl
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
2 #labels Stage-Beta
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
3
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
4 = Introduction =
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
5
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
6 This module allows you to perform various actions on user rosters via prosodyctl.
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
7
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
8 = Details =
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
9
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
10 After putting this module in your modules directory you can use it via prosodyctl like this:
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
11
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
12 {{{
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
13 prosodyctl mod_roster_command COMMAND [OPTIONS...]
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
14 }}}
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
15
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
16 == Commands ==
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
17
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
18 {{{
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
19 subscribe user@host contact@host
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
20 }}}
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
21
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
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).
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
23
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
24 {{{
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
25 subscribe_both user@host contact@host
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
26 }}}
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
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.
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
28
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
29 {{{
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
30 unsubscribe user@host contact@host
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
31 }}}
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
32
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
33 Removes a subscription to the contact's presence.
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
34
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
35 {{{
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
36 unsubscribe_both user@host contact@host
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
37 }}}
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
38
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
39 Same as unsubscribe, but also revokes a contact's subscription to the user's presence.
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
40
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
41 {{{
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
42 rename user@host contact@host [name] [group]
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
43 }}}
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
44
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
45 Sets or updates a name for a contact in the user's roster, and moves the contact to the given group, if specified.
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
46
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
47 = Compatibility =
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
48 || 0.8 || Works ||
e661e843f083 Created wiki page through web user interface.
MWild1
parents:
diff changeset
49 || 0.7 || Should work ||