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 *Note:* Do not add mod_roster_command to your Prosody config file. This is unnecessary because it will automatically be loaded by prosodyctl when you use it.

    17 

    18 == Commands ==

    19 

    20 {{{

    21     subscribe user@host contact@host

    22 }}}

    23 

    24 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).

    25 

    26 {{{

    27     subscribe_both user@host contact@host

    28 }}}

    29 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.

    30 

    31 {{{

    32     unsubscribe user@host contact@host

    33 }}}

    34 

    35 Removes a subscription to the contact's presence.

    36 

    37 {{{

    38     unsubscribe_both user@host contact@host

    39 }}}

    40 

    41 Same as unsubscribe, but also revokes a contact's subscription to the user's presence.

    42 

    43 {{{

    44     rename user@host contact@host [name] [group]

    45 }}}

    46 

    47 Sets or updates a name for a contact in the user's roster, and moves the contact to the given group, if specified.

    48 

    49 = Compatibility =

    50 || 0.9 || Works ||

    51 || 0.8 || Works ||