User.update

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(Created page with "'''user.update''' message")
 
 
(3 intermediate revisions by one user not shown)
Line 1: Line 1:
'''user.update''' message
+
'''user.update''' message used for users management: add, update and delete user.
 +
 
 +
===Parameters===
 +
 
 +
'''user'''
 +
:::The username of the user.
 +
'''operation'''
 +
:::The operation to fulfill or notify.
 +
:::Values:
 +
:::* add - create a user
 +
:::* update - update a user
 +
:::* delete - delete a user
 +
:::* query  - request a contact list
 +
 
 +
 
 +
There are modules that handles '''user.update''' message with operation: '''delete'''.The user is removed from memory and from database.<br>
 +
Other modules handle '''user.update''' message with operation: '''query''' that will request a list of contacts.<br>
 +
 
 +
===Example===
 +
 
 +
JabberServer Module will process message user.update with notify: 'delete' and will close the stream after user deletion.<br>
 +
JabberClient Module will handle the message user.update with operation: '''query'''.<br>
 +
Jbfeatures Module will request a modification that can be add or update or delete the user. Return values: true if operation was successful, false otherwise.
 +
 
 +
 
 +
'''See also'''
 +
 
 +
*[[resource.subscribe]]

Latest revision as of 18:37, 18 January 2013

user.update message used for users management: add, update and delete user.

[edit] Parameters

user

The username of the user.

operation

The operation to fulfill or notify.
Values:
  • add - create a user
  • update - update a user
  • delete - delete a user
  • query - request a contact list


There are modules that handles user.update message with operation: delete.The user is removed from memory and from database.
Other modules handle user.update message with operation: query that will request a list of contacts.

[edit] Example

JabberServer Module will process message user.update with notify: 'delete' and will close the stream after user deletion.
JabberClient Module will handle the message user.update with operation: query.
Jbfeatures Module will request a modification that can be add or update or delete the user. Return values: true if operation was successful, false otherwise.


See also

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers