asternet/docs/html/Properties_T_AsterNET_Manager_Event_QueueMemberEvent.htm
richard ralston 25e34f0b25 Adding documentation
Source Tree was giving trouble so commiting through Github app
2016-10-28 09:07:55 +02:00

62 lines
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<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>QueueMemberEvent Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="QueueMemberEvent class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:AsterNET.Manager.Event.QueueMemberEvent" /><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_QueueMemberEvent" /><meta name="guid" content="Properties_T_AsterNET_Manager_Event_QueueMemberEvent" /><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_QueueMemberEvent.htm" title="QueueMemberEvent Class" tocid="T_AsterNET_Manager_Event_QueueMemberEvent">QueueMemberEvent 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_QueueMemberEvent.htm" title="QueueMemberEvent Properties" tocid="Properties_T_AsterNET_Manager_Event_QueueMemberEvent">QueueMemberEvent Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_CallsTaken.htm" title="CallsTaken Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_CallsTaken">CallsTaken Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_LastCall.htm" title="LastCall Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_LastCall">LastCall Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_Location.htm" title="Location Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_Location">Location Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_MemberName.htm" title="MemberName Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_MemberName">MemberName Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_Membership.htm" title="Membership Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_Membership">Membership Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_Name.htm" title="Name Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_Name">Name Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_Paused.htm" title="Paused Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_Paused">Paused Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_Penalty.htm" title="Penalty Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_Penalty">Penalty Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_Queue.htm" title="Queue Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_Queue">Queue Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberEvent_Status.htm" title="Status Property " tocid="P_AsterNET_Manager_Event_QueueMemberEvent_Status">Status Property </a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize"><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize"></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="logoColumn"><img src="../icons/Help.png" /></td><td class="titleColumn">QueueMemberEvent Properties</td></tr></table><span class="introStyle"></span><p>The <a href="T_AsterNET_Manager_Event_QueueMemberEvent.htm">QueueMemberEvent</a> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID0RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</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_ResponseEvent_ActionId.htm">ActionId</a></td><td><div class="summary">
Get/Set the action id of the ManagerAction that caused this event.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ResponseEvent.htm">ResponseEvent</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_Attributes.htm">Attributes</a></td><td><div class="summary">
Store all unknown (without setter) keys from manager event.<br />
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_QueueMemberEvent_CallsTaken.htm">CallsTaken</a></td><td><div class="summary">
Get/Set the number of calls answered by the member.
</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;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;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Event_ResponseEvent_InternalActionId.htm">InternalActionId</a></td><td><div class="summary">
Get/Set the internal action id of the ManagerAction that caused this event.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ResponseEvent.htm">ResponseEvent</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_QueueMemberEvent_LastCall.htm">LastCall</a></td><td><div class="summary">
Get/Set the time (in seconds since 01/01/1970) the last successful call answered by the added member was hungup.
</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_QueueMemberEvent_Location.htm">Location</a></td><td><div class="summary">
Get/Set the name of the member's interface.<br />
E.g. the channel name or agent group.
</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_QueueMemberEvent_MemberName.htm">MemberName</a></td><td><div class="summary">
Get/Set the name of the queue member.
</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_QueueMemberEvent_Membership.htm">Membership</a></td><td><div class="summary">
Get/Set value if this member has been dynamically added by the QueueAdd command
(in the dialplan or via the Manager API) or if this member is has been
statically defined in queues.conf.
"dynamic" if the added member is a dynamic queue member, "static" if the added member is a static queue member.
</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_QueueMemberEvent_Name.htm">Name</a></td><td><div class="summary">
Get/Set the name of the queue member.
</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_QueueMemberEvent_Paused.htm">Paused</a></td><td><div class="summary">
Is this queue member paused (not accepting calls)?<br />
Available since Asterisk 1.2.<br />
true if this member has been paused,
false if not
</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_QueueMemberEvent_Penalty.htm">Penalty</a></td><td><div class="summary">
Get/Set the penalty for the added member. When calls are distributed members with higher penalties are considered last.
</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;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Event_QueueMemberEvent_Queue.htm">Queue</a></td><td><div class="summary">
Get/Set the name of the queue.
</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_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">
The ManagerConnection the Event was sourced from.
</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_QueueMemberEvent_Status.htm">Status</a></td><td><div class="summary">
Get/Set the status of this queue member.<br />
Available since Asterisk 1.2<br />
Valid status codes are:
<dl><dt>AST_DEVICE_UNKNOWN (0)</dt><dd>Queue member is available</dd><dt>AST_DEVICE_NOT_INUSE (1)</dt><dd>?</dd><dt>AST_DEVICE_INUSE (2)</dt><dd>?</dd><dt>AST_DEVICE_BUSY (3)</dt><dd>?</dd><dt>AST_DEVICE_INVALID (4)</dt><dd>?</dd><dt>AST_DEVICE_UNAVAILABLE (5)</dt><dd>?</dd></dl></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_QueueMemberEvent.htm">QueueMemberEvent 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>