User.roster

Latest revision as of 16:37, 15 November 2012

user.roster is a message sent by a module to update, delete or query user's contacts.

[edit] Parameters

account

The name of the account

operation

The operation to fulfill or notify.

Values:

• update: Update contacts
• delete: Remove contact(s) from list
• query: Query the server for contact list
• queryerror: Contact list query failed

contact.count

The number of contacts in the list. This parameter must be set when notifying update/delete from server.

Each contact will be prefixed by a 'contact.index' string. The index is ranging from 1 to contact.count.

Here is an example of how the first contact looks like for a jabber roster item:

   contact.1: The contact JID, e.g contact.1=user@domain.com
   contact.1.name: Optional contact name, e.g contact.1.name=John Doe
   contact.1.subscription: Contact subscription, e.g. contact.1.subscription=both (none, from, to or empty)
   contact.1.groups: Contact groups, e.g. contact.1.groups=Work,Friends 

contact

The contact to update (add) or delete. This parameter must be set when the user wants to request contact update or delete.

[edit] Optional parameters

The following parameters are optional for contact update requests sent to server:

name

Contact name to update

groups

Comma separated list of contact groups

extra

Comma separated list of extra parameters to set

NOTE: For jabber a contact update replaces all data in a roster entry: partial updates are not possible, e.g. a missing or empty contact name resets contact's name.