Click or drag to resize
PeerStatusEvent Properties

The PeerStatusEvent type exposes the following members.

Properties
  NameDescription
Public propertyAttributes
Store all unknown (without setter) keys from manager event.
Use in default Parse method [!:Parse(string key, string value)].
(Inherited from ManagerEvent.)
Public propertyCause
Returns the cause of a rejection or unregistration.
For IAX peers this is set only if the status equals "Rejected".
For SIP peers this is set if the status equals "Unregistered" and the peer was unregistered due to an expiration. In that case the cause is set to "Expired".
Public propertyChannel
Get/Set the name of the channel.
(Inherited from ManagerEvent.)
Public propertyChannelType
Channel type "SIP", "IAX2
Public propertyDateReceived
Get/Set the point in time this event was received from the Asterisk server.
Pseudo events that are not directly received from the asterisk server (for example ConnectEvent and DisconnectEvent) may return null.
(Inherited from ManagerEvent.)
Public propertyPeer
Returns the name of the peer that registered. The peer's name starts with "IAX2/" if it is an IAX client or "SIP/" if it is a SIP client. It is followed by the username that is used for registration.
Public propertyPeerStatus
Returns the registration state.
This may be one of
  • Registered
  • Unregistered
  • Reachable
  • Lagged
  • Unreachable
  • Rejected (IAX only)
Public propertyPrivilege
Get/Set the AMI authorization class of this event.
This is one or more of system, call, log, verbose, command, agent or user. Multiple privileges are separated by comma.
Note: This property is not available from Asterisk 1.0 servers.
(Inherited from ManagerEvent.)
Public propertyServer
Specify a server to which to send your commands (x.x.x.x or hostname).
This should match the server name specified in your config file's "host" entry. If you do not specify a server, the proxy will pick the first one it finds -- fine in single-server configurations.
(Inherited from ManagerEvent.)
Public propertySource
Event source.
(Inherited from ManagerEvent.)
Public propertyTime
Returns the ping time of the client if status equals "Reachable" or "Lagged"; if the status equals "Unreachable" it returns how long the last response took (in ms) for IAX peers or -1 for SIP peers.
Public propertyTimestamp
Returns the timestamp for this event.
The timestamp property is available in Asterisk since 1.4 if enabled in manager.conf by setting timestampevents = yes. In contains the time the event was generated in seconds since the epoch.
(Inherited from ManagerEvent.)
Public propertyUniqueId
Get/Set the unique id of the channel.
(Inherited from ManagerEvent.)
Top
See Also