asternet/docs/html/T_AsterNET_Manager_Response_GetConfigResponse.htm
2016-10-03 11:15:07 +02:00

72 lines
23 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>GetConfigResponse Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="GetConfigResponse class" /><meta name="System.Keywords" content="AsterNET.Manager.Response.GetConfigResponse class" /><meta name="System.Keywords" content="GetConfigResponse class, about GetConfigResponse class" /><meta name="Microsoft.Help.F1" content="AsterNET.Manager.Response.GetConfigResponse" /><meta name="Microsoft.Help.Id" content="T:AsterNET.Manager.Response.GetConfigResponse" /><meta name="Description" content="Response that is received when sending a GetConfigAction. Asterisk's response to the GetConfig command is ugly, and requires some parsing of attributes. This class lazily parses its own attributes to hide the ugly details." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager.Response" /><meta name="file" content="T_AsterNET_Manager_Response_GetConfigResponse" /><meta name="guid" content="T_AsterNET_Manager_Response_GetConfigResponse" /><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_Response.htm" title="AsterNET.Manager.Response" tocid="N_AsterNET_Manager_Response">AsterNET.Manager.Response</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="T_AsterNET_Manager_Response_GetConfigResponse.htm" title="GetConfigResponse Class" tocid="T_AsterNET_Manager_Response_GetConfigResponse">GetConfigResponse Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_Manager_Response_GetConfigResponse__ctor.htm" title="GetConfigResponse Constructor " tocid="M_AsterNET_Manager_Response_GetConfigResponse__ctor">GetConfigResponse Constructor </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="Fields_T_AsterNET_Manager_Response_GetConfigResponse.htm" title="GetConfigResponse Fields" tocid="Fields_T_AsterNET_Manager_Response_GetConfigResponse">GetConfigResponse Fields</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Methods_T_AsterNET_Manager_Response_GetConfigResponse.htm" title="GetConfigResponse Methods" tocid="Methods_T_AsterNET_Manager_Response_GetConfigResponse">GetConfigResponse Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Properties_T_AsterNET_Manager_Response_GetConfigResponse.htm" title="GetConfigResponse Properties" tocid="Properties_T_AsterNET_Manager_Response_GetConfigResponse">GetConfigResponse Properties</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">GetConfigResponse Class</td></tr></table><span class="introStyle"></span><div class="summary">
Response that is received when sending a GetConfigAction.<br />
Asterisk's response to the GetConfig command is ugly, and requires some
parsing of attributes. This class lazily parses its own attributes to hide
the ugly details. If the file requested exists but does not contain at least
a line with a category, the ResponseBuilder won't create an instance of
GetConfigResponse, as it won't know what the empty response is.
</div><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" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LSTC626F230_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC626F230_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">AsterNET.Manager.Response<span id="LSTC626F230_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC626F230_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ManagerResponse</a><br />    <span class="selflink">AsterNET.Manager.Response<span id="LSTC626F230_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC626F230_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>GetConfigResponse</span><br /></div><p> </p><strong>Namespace:</strong> <a href="N_AsterNET_Manager_Response.htm">AsterNET.Manager.Response</a><br /><strong>Assembly:</strong> AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cs','1','4');return false;">C#</a></div><div id="ID1EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','vb','2','4');return false;">VB</a></div><div id="ID1EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cpp','3','4');return false;">C++</a></div><div id="ID1EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID1EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID1EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">GetConfigResponse</span> : <span class="identifier">ManagerResponse</span></pre></div><div id="ID1EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">GetConfigResponse</span>
<span class="keyword">Inherits</span> <span class="identifier">ManagerResponse</span></pre></div><div id="ID1EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">GetConfigResponse</span> : <span class="keyword">public</span> <span class="identifier">ManagerResponse</span></pre></div><div id="ID1EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">GetConfigResponse</span> =
<span class="keyword">class</span>
<span class="keyword">inherit</span> <span class="identifier">ManagerResponse</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <span class="selflink">GetConfigResponse</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" 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/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Response_GetConfigResponse__ctor.htm">GetConfigResponse</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">GetConfigResponse</span> class</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID4RBSection" 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/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">Determines whether the specified <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is equal to the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td><div class="summary">Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Response_ManagerResponse_GetAttribute.htm">GetAttribute</a></td><td><div class="summary">
Returns the value of the attribute with the given key.<br />
This is particulary important when a response contains special
attributes that are dependent on the action that has been sent.<br />
An example of this is the response to the GetVarAction.
It contains the value of the channel variable as an attribute
stored under the key of the variable name.<br />
Example:
<pre>
GetVarAction action = new GetVarAction();
action.setChannel("SIP/1310-22c3");
action.setVariable("ALERT_INFO");
ManagerResponse response = connection.SendAction(action);
String alertInfo = response.getAttribute("ALERT_INFO");
</pre>
As all attributes are internally stored in lower case the key is
automatically converted to lower case before lookup.
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">Serves as a hash function for a particular type. </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Response_ManagerResponse_IsSuccess.htm">IsSuccess</a></td><td><div class="summary">
Return true if Response is success
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Response_GetConfigResponse_Lines.htm">Lines</a></td><td><div class="summary">
Returns the map of line number to line value for a given category.
</div></td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td><div class="summary">Creates a shallow copy of the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Response_ManagerResponse_Parse.htm">Parse</a></td><td><div class="summary">
Unknown properties parser
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Response_ManagerResponse_ParseSpecial.htm">ParseSpecial</a></td><td><div class="summary">
Unknown properties parser
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Response_ManagerResponse_ToString.htm">ToString</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID5RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protfield.gif" alt="Protected field" title="Protected field" /></td><td><a href="F_AsterNET_Manager_Response_ManagerResponse_attributes.htm">attributes</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID6RBSection" 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_Response_ManagerResponse_ActionId.htm">ActionId</a></td><td><div class="summary">
Get/Set the action id received with this response referencing the action that generated this response.
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</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_Response_ManagerResponse_Attributes.htm">Attributes</a></td><td><div class="summary">
Store all unknown (without setter) keys from manager event.<br />
Use in default Parse method <span class="nolink">[!:Parse(string key, string value)]</span>.
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</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_Response_GetConfigResponse_Categories.htm">Categories</a></td><td><div class="summary">
Get the map of category numbers to category names.
</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_Response_ManagerResponse_DateReceived.htm">DateReceived</a></td><td><div class="summary">
Get/Set the point in time this response was received from the asterisk server.
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</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_Response_ManagerResponse_Message.htm">Message</a></td><td><div class="summary">
Get/Set the message received with this response.<br />
The content depends on the action that generated this response.
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</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_Response_ManagerResponse_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_Response_ManagerResponse.htm">ManagerResponse</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_Response_ManagerResponse_Response.htm">Response</a></td><td><div class="summary">
Get/Set the value of the "Response:" line.<br />
This typically a String like "Success" or "Error" but depends on the action that generated this response.
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</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_Response_ManagerResponse_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_Response_ManagerResponse.htm">ManagerResponse</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_Response_ManagerResponse_UniqueId.htm">UniqueId</a></td><td><div class="summary">
Get/Set the unique id received with this response.<br />
The unique id is used to keep track of channels created by the action sent, for example an OriginateAction.
</div> (Inherited from <a href="T_AsterNET_Manager_Response_ManagerResponse.htm">ManagerResponse</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID7RB')" onkeypress="SectionExpandCollapse_CheckKey('ID7RB', event)" tabindex="0"><img id="ID7RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID7RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="N_AsterNET_Manager_Response.htm">AsterNET.Manager.Response Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>