asternet/docs/html/Properties_T_AsterNET_Manager_Event_FaxReceivedEvent.htm
2016-11-22 09:38:55 +02:00

62 lines
17 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>FaxReceivedEvent Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="FaxReceivedEvent class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:AsterNET.Manager.Event.FaxReceivedEvent" /><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_FaxReceivedEvent" /><meta name="guid" content="Properties_T_AsterNET_Manager_Event_FaxReceivedEvent" /><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_FaxReceivedEvent.htm" title="FaxReceivedEvent Class" tocid="T_AsterNET_Manager_Event_FaxReceivedEvent">FaxReceivedEvent 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_FaxReceivedEvent.htm" title="FaxReceivedEvent Properties" tocid="Properties_T_AsterNET_Manager_Event_FaxReceivedEvent">FaxReceivedEvent Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_FaxReceivedEvent_CallerId.htm" title="CallerId Property " tocid="P_AsterNET_Manager_Event_FaxReceivedEvent_CallerId">CallerId Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_FaxReceivedEvent_Exten.htm" title="Exten Property " tocid="P_AsterNET_Manager_Event_FaxReceivedEvent_Exten">Exten Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_FaxReceivedEvent_Filename.htm" title="Filename Property " tocid="P_AsterNET_Manager_Event_FaxReceivedEvent_Filename">Filename Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_FaxReceivedEvent_LocalStationId.htm" title="LocalStationId Property " tocid="P_AsterNET_Manager_Event_FaxReceivedEvent_LocalStationId">LocalStationId Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_FaxReceivedEvent_PagesTransferred.htm" title="PagesTransferred Property " tocid="P_AsterNET_Manager_Event_FaxReceivedEvent_PagesTransferred">PagesTransferred Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_FaxReceivedEvent_RemoteStationId.htm" title="RemoteStationId Property " tocid="P_AsterNET_Manager_Event_FaxReceivedEvent_RemoteStationId">RemoteStationId Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_FaxReceivedEvent_Resolution.htm" title="Resolution Property " tocid="P_AsterNET_Manager_Event_FaxReceivedEvent_Resolution">Resolution Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_FaxReceivedEvent_TransferRate.htm" title="TransferRate Property " tocid="P_AsterNET_Manager_Event_FaxReceivedEvent_TransferRate">TransferRate 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">FaxReceivedEvent Properties</td></tr></table><span class="introStyle"></span><p>The <a href="T_AsterNET_Manager_Event_FaxReceivedEvent.htm">FaxReceivedEvent</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;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Event_FaxReceivedEvent_CallerId.htm">CallerId</a></td><td><div class="summary">
Get/Set the Caller*ID of the calling party or an empty string if none is
<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></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;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Event_FaxReceivedEvent_Exten.htm">Exten</a></td><td><div class="summary">
Get/Set the extension in Asterisk's dialplan the fax was received
<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></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_FaxReceivedEvent_Filename.htm">Filename</a></td><td><div class="summary">
Get/Set the filename of the received fax including its full path on the Asterisk server.
<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></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_FaxReceivedEvent_LocalStationId.htm">LocalStationId</a></td><td><div class="summary">
Get/Set the identifier of the local fax station.
<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></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_AbstractAgentEvent_Member.htm">Member</a></td><td><div class="summary">
Get/Set the name of the member's interface.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractAgentEvent.htm">AbstractAgentEvent</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_AbstractAgentEvent_MemberName.htm">MemberName</a></td><td><div class="summary">
Get/Set the name of the member's interface.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractAgentEvent.htm">AbstractAgentEvent</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_FaxReceivedEvent_PagesTransferred.htm">PagesTransferred</a></td><td><div class="summary">
Get/Set the number of pages transferred.
<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></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_AbstractAgentEvent_Queue.htm">Queue</a></td><td><div class="summary">
Get/Set the name of the queue.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractAgentEvent.htm">AbstractAgentEvent</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_FaxReceivedEvent_RemoteStationId.htm">RemoteStationId</a></td><td><div class="summary">
Get/Set the identifier of the remote fax station.
<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></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_FaxReceivedEvent_Resolution.htm">Resolution</a></td><td><div class="summary">
Get/Set the row resolution of the received fax.
<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></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_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;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Event_FaxReceivedEvent_TransferRate.htm">TransferRate</a></td><td><div class="summary">
Get/Set the transfer rate in bits/s.
<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></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><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_AbstractAgentVariables_Variable.htm">Variable</a></td><td> <strong>Obsolete. </strong><div class="summary">
Get/Set the variables to set on the queue call in native asterisk format.<br />
Example: "VAR1=abc|VAR2=def".
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractAgentVariables.htm">AbstractAgentVariables</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_FaxReceivedEvent.htm">FaxReceivedEvent 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>