asternet/docs/html/Properties_T_AsterNET_Manager_Action_LoginAction.htm

26 lines
10 KiB
HTML
Raw Normal View History

<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>LoginAction Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="LoginAction class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:AsterNET.Manager.Action.LoginAction" /><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_LoginAction" /><meta name="guid" content="Properties_T_AsterNET_Manager_Action_LoginAction" /><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_LoginAction.htm" title="LoginAction Class" tocid="T_AsterNET_Manager_Action_LoginAction">LoginAction 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_LoginAction.htm" title="LoginAction Properties" tocid="Properties_T_AsterNET_Manager_Action_LoginAction">LoginAction Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_LoginAction_Action.htm" title="Action Property " tocid="P_AsterNET_Manager_Action_LoginAction_Action">Action Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_LoginAction_AuthType.htm" title="AuthType Property " tocid="P_AsterNET_Manager_Action_LoginAction_AuthType">AuthType Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_LoginAction_Events.htm" title="Events Property " tocid="P_AsterNET_Manager_Action_LoginAction_Events">Events Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_LoginAction_Key.htm" title="Key Property " tocid="P_AsterNET_Manager_Action_LoginAction_Key">Key Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Action_LoginAction_Secret.htm" title="Secret Property " tocid="P_AsterNET_Manager_Action_LoginAction_Secret">Secret Property </a>
 
</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_LoginAction_Action.htm">Action</a></td><td><div class="summary">
Get the name of this action, i.e. "Login".
</div> (Overrides <a href="P_AsterNET_Manager_Action_ManagerAction_Action.htm">ManagerAction<span id="LST90954142_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST90954142_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_LoginAction_AuthType.htm">AuthType</a></td><td><div class="summary">
Get/Set the digest alogrithm when using challenge/response.<br />
The digest algorithm is used to create the key based on the challenge and
the user's password.<br />
Currently Asterisk supports only "MD5".
</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_LoginAction_Events.htm">Events</a></td><td><div class="summary">
Get/Set the event mask.<br />
Set to "on" if all events should be send, "off" if not events should be sent or a combination of
"system", "call" and "log" (separated by ',') to specify what kind of events should be sent.
</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_LoginAction_Key.htm">Key</a></td><td><div class="summary">
Get/Set the key.
</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> (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_LoginAction_Secret.htm">Secret</a></td><td><div class="summary">
Get/Set the secret to use when using cleartext login.<br />
The secret contains the user's password as configured in Asterisk's manager.conf.<br />
The secret and key properties are mutually exclusive.
</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><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_LoginAction_Username.htm">Username</a></td><td><div class="summary">
Get/Set the username as configured in asterik's manager.conf.
</div></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_LoginAction.htm">LoginAction 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>