2016-10-03 09:15:07 +00:00
< html > < head > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < link rel = "shortcut icon" href = "../icons/favicon.ico" / > < link rel = "stylesheet" type = "text/css" href = "../styles/branding.css" / > < link rel = "stylesheet" type = "text/css" href = "../styles/branding-en-US.css" / > < script type = "text/javascript" src = "../scripts/branding.js" > < / script > < meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" / > < title > PeerStatusEvent Properties< / title > < meta name = "Language" content = "en-us" / > < meta name = "System.Keywords" content = "PeerStatusEvent class, properties" / > < meta name = "Microsoft.Help.Id" content = "Properties.T:AsterNET.Manager.Event.PeerStatusEvent" / > < meta name = "Microsoft.Help.ContentType" content = "Reference" / > < meta name = "BrandingAware" content = "true" / > < meta name = "container" content = "AsterNET.Manager.Event" / > < meta name = "file" content = "Properties_T_AsterNET_Manager_Event_PeerStatusEvent" / > < meta name = "guid" content = "Properties_T_AsterNET_Manager_Event_PeerStatusEvent" / > < link rel = "stylesheet" type = "text/css" href = "../styles/branding-Website.css" / > < script type = "text/javascript" src = "../scripts/jquery-1.11.0.min.js" > < / script > < script type = "text/javascript" src = "../scripts/branding-Website.js" > < / script > < / head > < body onload = "OnLoad('cs')" > < input type = "hidden" id = "userDataCache" class = "userDataStyle" / > < div class = "pageHeader" id = "PageHeader" > AsterNet Class Library (Sandcastle documentation)< form id = "SearchForm" method = "get" action = "#" onsubmit = "javascript:TransferToSearchPage(); return false;" > < input id = "SearchTextBox" type = "text" maxlength = "200" / > < button id = "SearchButton" type = "submit" > < / button > < / form > < / div > < div class = "pageBody" > < div class = "leftNav" id = "leftNav" > < div id = "tocNav" > < div class = "toclevel0" data-toclevel = "0" > < a class = "tocCollapsed" onclick = "javascript: Toggle(this);" href = "#!" > < / a > < a data-tochassubtree = "true" href = "79b6241e-05a3-441c-b6a1-51f2b5b7f265.htm" title = "AsterNet Class Library (Sandcastle documentation)" tocid = "roottoc" > AsterNet Class Library (Sandcastle documentation)< / a > < / div > < div class = "toclevel0" data-toclevel = "0" > < a class = "tocCollapsed" onclick = "javascript: Toggle(this);" href = "#!" > < / a > < a data-tochassubtree = "true" href = "N_AsterNET_Manager_Event.htm" title = "AsterNET.Manager.Event" tocid = "N_AsterNET_Manager_Event" > AsterNET.Manager.Event< / a > < / div > < div class = "toclevel0" data-toclevel = "0" > < a class = "tocCollapsed" onclick = "javascript: Toggle(this);" href = "#!" > < / a > < a data-tochassubtree = "true" href = "T_AsterNET_Manager_Event_PeerStatusEvent.htm" title = "PeerStatusEvent Class" tocid = "T_AsterNET_Manager_Event_PeerStatusEvent" > PeerStatusEvent Class< / a > < / div > < div class = "toclevel1 current" data-toclevel = "1" data-childrenloaded = "true" > < a class = "tocExpanded" onclick = "javascript: Toggle(this);" href = "#!" > < / a > < a data-tochassubtree = "true" href = "Properties_T_AsterNET_Manager_Event_PeerStatusEvent.htm" title = "PeerStatusEvent Properties" tocid = "Properties_T_AsterNET_Manager_Event_PeerStatusEvent" > PeerStatusEvent Properties< / a > < / div > < div class = "toclevel2" data-toclevel = "2" > < a data-tochassubtree = "false" href = "P_AsterNET_Manager_Event_PeerStatusEvent_Cause.htm" title = "Cause Property " tocid = "P_AsterNET_Manager_Event_PeerStatusEvent_Cause" > Cause Property < / a > < / div > < div class = "toclevel2" data-toclevel = "2" > < a data-tochassubtree = "false" href = "P_AsterNET_Manager_Event_PeerStatusEvent_ChannelType.htm" title = "ChannelType Property " tocid = "P_AsterNET_Manager_Event_PeerStatusEvent_ChannelType" > ChannelType Property < / a > < / div > < div class = "toclevel2" data-toclevel = "2" > < a data-tochassubtree = "false" href = "P_AsterNET_Manager_Event_PeerStatusEvent_Peer.htm" title = "Peer Property " tocid = "P_AsterNET_Manager_Event_PeerStatusEvent_Peer" > Peer Property < / a > < / div > < div class = "toclevel2" data-toclevel = "2" > < a data-tochassubtree = "false" href = "P_AsterNET_Manager_Event_PeerStatusEvent_PeerStatus.htm" title = "PeerStatus Property " tocid = "P_AsterNET_Manager_Event_PeerStatusEvent_PeerStatus" > PeerStatus Property < / a > < / div > < div class = "toclevel2" data-toclevel = "2" > < a data-tochassubtree = "false" href = "P_AsterNET_Manager_Event_PeerStatusEvent_Time.htm" title
< / th > < th > Name< / th > < th > Description< / th > < / tr > < tr data = "public;inherited;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_ManagerEvent_Attributes.htm" > Attributes< / a > < / td > < td > < div class = "summary" >
Store all unknown (without setter) keys from manager event.< br / >
2016-10-05 06:38:17 +00:00
Use in default Parse method < a href = "M_AsterNET_Manager_Event_ManagerEvent_Parse.htm" > Parse(String, String)< / a > < / div > (Inherited from < a href = "T_AsterNET_Manager_Event_ManagerEvent.htm" > ManagerEvent< / a > .)< / td > < / tr > < tr data = "public;declared;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_PeerStatusEvent_Cause.htm" > Cause< / a > < / td > < td > < div class = "summary" >
2016-10-03 09:15:07 +00:00
Returns the cause of a rejection or unregistration.< br / >
For IAX peers this is set only if the status equals "Rejected".< br / >
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".
< / div > < / td > < / tr > < tr data = "public;inherited;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_ManagerEvent_Channel.htm" > Channel< / a > < / td > < td > < div class = "summary" >
Get/Set the name of the channel.
< / div > (Inherited from < a href = "T_AsterNET_Manager_Event_ManagerEvent.htm" > ManagerEvent< / a > .)< / td > < / tr > < tr data = "public;declared;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_PeerStatusEvent_ChannelType.htm" > ChannelType< / a > < / td > < td > < div class = "summary" >
Channel type
"SIP",
"IAX2
< / div > < / td > < / tr > < tr data = "public;inherited;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_ManagerEvent_DateReceived.htm" > DateReceived< / a > < / td > < td > < div class = "summary" >
Get/Set the point in time this event was received from the Asterisk server.< br / >
Pseudo events that are not directly received from the asterisk server
(for example ConnectEvent and DisconnectEvent) may return null.
< / div > (Inherited from < a href = "T_AsterNET_Manager_Event_ManagerEvent.htm" > ManagerEvent< / a > .)< / td > < / tr > < tr data = "public;declared;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_PeerStatusEvent_Peer.htm" > Peer< / a > < / td > < td > < div class = "summary" >
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.
< / div > < / td > < / tr > < tr data = "public;declared;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_PeerStatusEvent_PeerStatus.htm" > PeerStatus< / a > < / td > < td > < div class = "summary" > Returns the registration state.< br / >
This may be one of
< ul > < li > Registered< / li > < li > Unregistered< / li > < li > Reachable< / li > < li > Lagged< / li > < li > Unreachable< / li > < li > Rejected (IAX only)< / li > < / ul > < / div > < / td > < / tr > < tr data = "public;inherited;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_ManagerEvent_Privilege.htm" > Privilege< / a > < / td > < td > < div class = "summary" >
Get/Set the AMI authorization class of this event.< br / >
This is one or more of system, call, log, verbose, command, agent or user.
Multiple privileges are separated by comma.< br / >
Note: This property is not available from Asterisk 1.0 servers.
< / div > (Inherited from < a href = "T_AsterNET_Manager_Event_ManagerEvent.htm" > ManagerEvent< / a > .)< / td > < / tr > < tr data = "public;inherited;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_ManagerEvent_Server.htm" > Server< / a > < / td > < td > < div class = "summary" >
Specify a server to which to send your commands (x.x.x.x or hostname).< br / >
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.
< / div > (Inherited from < a href = "T_AsterNET_Manager_Event_ManagerEvent.htm" > ManagerEvent< / a > .)< / td > < / tr > < tr data = "public;inherited;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_ManagerEvent_Source.htm" > Source< / a > < / td > < td > < div class = "summary" >
2016-10-05 06:38:17 +00:00
The ManagerConnection the Event was sourced from.
2016-10-03 09:15:07 +00:00
< / div > (Inherited from < a href = "T_AsterNET_Manager_Event_ManagerEvent.htm" > ManagerEvent< / a > .)< / td > < / tr > < tr data = "public;declared;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_PeerStatusEvent_Time.htm" > Time< / a > < / td > < td > < div class = "summary" >
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.
< / div > < / td > < / tr > < tr data = "public;inherited;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_ManagerEvent_Timestamp.htm" > Timestamp< / a > < / td > < td > < div class = "summary" >
Returns the timestamp for this event.< br / >
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.
< / div > (Inherited from < a href = "T_AsterNET_Manager_Event_ManagerEvent.htm" > ManagerEvent< / a > .)< / td > < / tr > < tr data = "public;inherited;notNetfw;" > < td > < img src = "../icons/pubproperty.gif" alt = "Public property" title = "Public property" / > < / td > < td > < a href = "P_AsterNET_Manager_Event_ManagerEvent_UniqueId.htm" > UniqueId< / a > < / td > < td > < div class = "summary" >
Get/Set the unique id of the channel.
< / div > (Inherited from < a href = "T_AsterNET_Manager_Event_ManagerEvent.htm" > ManagerEvent< / a > .)< / td > < / tr > < / table > < a href = "#PageHeader" > Top< / a > < / div > < div class = "collapsibleAreaRegion" id = "seeAlsoSection" > < span class = "collapsibleRegionTitle" onclick = "SectionExpandCollapse('ID1RB')" onkeypress = "SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex = "0" > < img id = "ID1RBToggle" class = "collapseToggle" src = "../icons/SectionExpanded.png" / > See Also< / span > < / div > < div id = "ID1RBSection" class = "collapsibleSection" > < h4 class = "subHeading" > Reference< / h4 > < div class = "seeAlsoStyle" > < a href = "T_AsterNET_Manager_Event_PeerStatusEvent.htm" > PeerStatusEvent Class< / a > < / div > < div class = "seeAlsoStyle" > < a href = "N_AsterNET_Manager_Event.htm" > AsterNET.Manager.Event Namespace< / a > < / div > < / div > < / div > < / div > < div id = "pageFooter" class = "pageFooter" > < / div > < / body > < / html >
