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

31 lines
11 KiB
HTML
Raw Permalink 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>QueueAddAction Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="QueueAddAction class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:AsterNET.Manager.Action.QueueAddAction" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager.Action" /><meta name="file" content="Properties_T_AsterNET_Manager_Action_QueueAddAction" /><meta name="guid" content="Properties_T_AsterNET_Manager_Action_QueueAddAction" /><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_Action.htm" title="AsterNET.Manager.Action" tocid="N_AsterNET_Manager_Action">AsterNET.Manager.Action</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_Action_QueueAddAction.htm" title="QueueAddAction Class" tocid="T_AsterNET_Manager_Action_QueueAddAction">QueueAddAction 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_Action_QueueAddAction.htm" title="QueueAddAction Properties" tocid="Properties_T_AsterNET_Manager_Action_QueueAddAction">QueueAddAction Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_QueueAddAction_Action.htm" title="Action Property " tocid="P_AsterNET_Manager_Action_QueueAddAction_Action">Action Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_QueueAddAction_Interface.htm" title="Interface Property " tocid="P_AsterNET_Manager_Action_QueueAddAction_Interface">Interface Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_QueueAddAction_MemberName.htm" title="MemberName Property " tocid="P_AsterNET_Manager_Action_QueueAddAction_MemberName">MemberName Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_QueueAddAction_Paused.htm" title="Paused Property " tocid="P_AsterNET_Manager_Action_QueueAddAction_Paused">Paused Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_QueueAddAction_Penalty.htm" title="Penalty Property " tocid="P_AsterNET_Manager_Action_QueueAddAction_Penalty">Penalty Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_QueueAddAction_Queue.htm" title="Queue Property " tocid="P_AsterNET_Manager_Action_QueueAddAction_Queue">Queue 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">QueueAddAction Properties</td></tr></table><span class="introStyle"></span><p>The <a href="T_AsterNET_Manager_Action_QueueAddAction.htm">QueueAddAction</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;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_QueueAddAction_Action.htm">Action</a></td><td><div class="summary">
Get the name of this action, i.e. "QueueAdd".
</div> (Overrides <a href="P_AsterNET_Manager_Action_ManagerAction_Action.htm">ManagerAction<span id="LST4E4CD293_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4E4CD293_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Action</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_Action_ManagerAction_ActionId.htm">ActionId</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</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_Action_QueueAddAction_Interface.htm">Interface</a></td><td><div class="summary">
Get/Set the interface to add. To add a specific channel just use the channel name, e.g. "SIP/1234".<br />
This property is mandatory.
</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_Action_QueueAddAction_MemberName.htm">MemberName</a></td><td><div class="summary">
Get/Set the member to add.
</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_Action_QueueAddAction_Paused.htm">Paused</a></td><td><div class="summary">
Get/Set if the queue member should be paused when added.<br />
true if the queue member should be paused when added.
</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_Action_QueueAddAction_Penalty.htm">Penalty</a></td><td><div class="summary">
Get/Set the penalty for this member.<br />
The penalty must be a positive integer or 0 for no penalty. If it is not set 0 is assumed.<br />
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_Action_ManagerAction_ProxyKey.htm">ProxyKey</a></td><td><div class="summary">
You can use this as a simple authentication mechanism.<br />
Rather than have to login with a username &amp; password,
you can specify a <b>ProxyKey</b> that must be passed from
a client before requests are processed.<br />
This is helpful in situations where you would like to authenticate and
execute an action in a single step.
</div> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</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_Action_QueueAddAction_Queue.htm">Queue</a></td><td><div class="summary">
Get/Set the name of the queue the new member will be added to.<br />
This property is mandatory.
</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_Action_ManagerAction_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_Action_ManagerAction.htm">ManagerAction</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_Action_QueueAddAction.htm">QueueAddAction Class</a></div><div class="seeAlsoStyle"><a href="N_AsterNET_Manager_Action.htm">AsterNET.Manager.Action Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>