User.notify
From Yate Documentation
(Difference between revisions)
(→Message parameters) |
|||
Line 19: | Line 19: | ||
'''reason''' | '''reason''' | ||
:::failure or deregistration reason if known | :::failure or deregistration reason if known | ||
+ | |||
+ | |||
+ | '''See also''' | ||
+ | |||
+ | * [[user.register]] |
Latest revision as of 13:00, 21 January 2013
The user.notify message is emitted by channels that support client registration to other servers. It is generated asynchronously every time the registration status of an account changes, either because of operating conditions (network failure, server configuration changes) or because of a local account update (an user.login message).
Since the message should be observed by multiple modules all handlers must return false.
[edit] Message parameters
account
- account name that generated the notification
protocol
- the protocol that handles the account - H323, SIP or IAX
registered
- boolean value indicating the current registration status
[edit] Optional parameters
username
- user name for the account where applicable
reason
- failure or deregistration reason if known
See also