snow/asternet
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
asternet/docs/html/Properties_T_AsterNET_Manager_Event_QueueMemberPauseEvent.htm
Herman van den Berg 72ddf45b9f fixed XML documentation errors 
enable XML documentation output (for intellisense when using as a dll, eg Nuget)
update Sandcastle documentation (allows enabling Git Hub Pages, see: https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/ , uses '/docs' folder)
2016-10-19 09:20:23 +02:00

67 lines
20 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>QueueMemberPauseEvent Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="QueueMemberPauseEvent class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:AsterNET.Manager.Event.QueueMemberPauseEvent" /><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_QueueMemberPauseEvent" /><meta name="guid" content="Properties_T_AsterNET_Manager_Event_QueueMemberPauseEvent" /><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_QueueMemberPauseEvent.htm" title="QueueMemberPauseEvent Class" tocid="T_AsterNET_Manager_Event_QueueMemberPauseEvent">QueueMemberPauseEvent 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_QueueMemberPauseEvent.htm" title="QueueMemberPauseEvent Properties" tocid="Properties_T_AsterNET_Manager_Event_QueueMemberPauseEvent">QueueMemberPauseEvent Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_QueueMemberPauseEvent_Reason.htm" title="Reason Property " tocid="P_AsterNET_Manager_Event_QueueMemberPauseEvent_Reason">Reason 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">QueueMemberPauseEvent Properties</td></tr></table><span class="introStyle"></span><p>The <a href="T_AsterNET_Manager_Event_QueueMemberPauseEvent.htm">QueueMemberPauseEvent</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_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;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Event_AbstractQueueMemberEvent_CallsTaken.htm">CallsTaken</a></td><td><div class="summary">
The number of calls this queue member has serviced.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_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_AbstractQueueMemberEvent_InCall.htm">InCall</a></td><td><div class="summary">
Evaluates <span class="keyword"><span id="LSTAB3B26_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTAB3B26_0?vb=True|nu=true");</script></span> if member is in call,
<span class="keyword"><span id="LSTAB3B26_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTAB3B26_1?vb=False|nu=false");</script></span> after LastCall time is updated.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Documentation" target="_blank" title="Asterisk 13 wiki docs">Asterisk 13</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_AbstractQueueMemberEvent_Interface.htm">Interface</a></td><td><div class="summary">
The queue member's channel technology or location.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_AbstractQueueMemberEvent_LastCall.htm">LastCall</a></td><td><div class="summary">
The time this member last took a call, expressed in seconds since 00:00, Jan 1, 1970 UTC.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_AbstractQueueMemberEvent_Location.htm">Location</a></td><td><div class="summary">
Returns the name of the member's interface.<br />
E.g. the channel name or agent group.<br /><b>Removed since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.<br /><b>Replaced by : </b><a href="P_AsterNET_Manager_Event_AbstractQueueMemberEvent_Interface.htm">Interface</a> since <a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_AbstractQueueMemberEvent_MemberName.htm">MemberName</a></td><td><div class="summary">
The name of the queue member.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_AbstractQueueMemberEvent_Membership.htm">Membership</a></td><td><div class="summary">
"dynamic" if the added member is a dynamic queue member,<br />
"realtime" if the added member is a realtime queue member,<br />
"static" if the added member is a static queue member.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_AbstractQueueMemberEvent_Paused.htm">Paused</a></td><td><div class="summary">
When queue member is paused (not accepting calls).<br />
Evaluates <span class="keyword"><span id="LSTAB3B26_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTAB3B26_2?vb=True|nu=true");</script></span> if this member has been paused,
<span class="keyword"><span id="LSTAB3B26_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTAB3B26_3?vb=False|nu=false");</script></span> if not.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_AbstractQueueMemberEvent_PausedReason.htm">PausedReason</a></td><td><div class="summary">
If set when paused, the reason the queue member was paused.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Documentation" target="_blank" title="Asterisk 13 wiki docs">Asterisk 13</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_AbstractQueueMemberEvent_Penalty.htm">Penalty</a></td><td><div class="summary">
The penalty associated with the queue member. When calls are distributed members with higher penalties are considered last.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_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_AbstractQueueMemberEvent_Queue.htm">Queue</a></td><td><div class="summary">
The name of the queue.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_QueueMemberPauseEvent_Reason.htm">Reason</a></td><td><div class="summary">
The reason a member was paused.
</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_AbstractQueueMemberEvent_Ringinuse.htm">Ringinuse</a></td><td><div class="summary">
Evaluates <span class="keyword"><span id="LSTAB3B26_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTAB3B26_4?vb=True|nu=true");</script></span> if Ringinuse,
<span class="keyword"><span id="LSTAB3B26_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTAB3B26_5?vb=False|nu=false");</script></span> if not.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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">
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;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Event_AbstractQueueMemberEvent_StateInterface.htm">StateInterface</a></td><td><div class="summary">
Channel technology or location from which to read device state changes.<br /><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_AbstractQueueMemberEvent_Status.htm">Status</a></td><td><div class="summary">
The numeric device state status of the queue member.<br /><p>
Valid status codes are:<br /><ol start="0"><li>AST_DEVICE_UNKNOWN</li><li>AST_DEVICE_NOT_INUSE</li><li>AST_DEVICE_INUSE</li><li>AST_DEVICE_BUSY</li><li>AST_DEVICE_INVALID</li><li>AST_DEVICE_UNAVAILABLE</li><li>AST_DEVICE_RINGING</li><li>AST_DEVICE_RINGINUSE</li><li>AST_DEVICE_ONHOLD</li></ol></p><b>Available since : </b><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Documentation" target="_blank" title="Asterisk 12 wiki docs">Asterisk 12</a>.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</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_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_QueueMemberPauseEvent.htm">QueueMemberPauseEvent 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>
Reference in a new issue View git blame Copy permalink