FaxReceivedEvent Class

A FaxReceivedEvent is triggered by spandsp after a new fax has been received.
It is only available if you installed the spandsp patches to Asterisk.
See http://soft-switch.org/installing-spandsp.html for details.
Implemented in apps/app_rxfax.c.

Inheritance Hierarchy

SystemObject
  SystemEventArgs
    AsterNET.Manager.EventManagerEvent
      AsterNET.Manager.EventAbstractAgentVariables
        AsterNET.Manager.EventAbstractAgentEvent
          AsterNET.Manager.EventFaxReceivedEvent

Namespace: AsterNET.Manager.Event
Assembly: AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public class FaxReceivedEvent : AbstractAgentEvent

Public Class FaxReceivedEvent
	Inherits AbstractAgentEvent

public ref class FaxReceivedEvent : public AbstractAgentEvent

type FaxReceivedEvent =  
    class
        inherit AbstractAgentEvent
    end

The FaxReceivedEvent type exposes the following members.

Constructors

	Name	Description
	FaxReceivedEvent	Initializes a new instance of the FaxReceivedEvent class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVariable	Gets a variable on the originated call. Replaces any existing variable with the same name. (Inherited from AbstractAgentVariables.)
	GetVariables	Get the variables dictionary to set on the originated call. (Inherited from AbstractAgentVariables.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Parse	Unknown properties parser (Inherited from ManagerEvent.)
	ParseSpecial	Unknown properties parser. (Inherited from ManagerEvent.)
	SetVariable	Sets a variable dictionary on the originated call. Replaces any existing variable with the same name. (Inherited from AbstractAgentVariables.)
	SetVariables	Set the variables dictionary to set on the originated call. (Inherited from AbstractAgentVariables.)
	ToString	Convert all properties to string (Inherited from ManagerEvent.)

Top

Properties

	Name	Description
	Attributes	Store all unknown (without setter) keys from manager event. Use in default Parse method Parse(String, String) (Inherited from ManagerEvent.)
	CallerId	Get/Set the CallerID of the calling party or an empty string if none is Available since :* Asterisk 12.
	Channel	Get/Set the name of the channel. (Inherited from ManagerEvent.)
	DateReceived	Get/Set the point in time this event was received from the Asterisk server. Pseudo events that are not directly received from the asterisk server (for example ConnectEvent and DisconnectEvent) may return null. (Inherited from ManagerEvent.)
	Exten	Get/Set the extension in Asterisk's dialplan the fax was received Available since : Asterisk 12.
	Filename	Get/Set the filename of the received fax including its full path on the Asterisk server. Available since : Asterisk 12.
	LocalStationId	Get/Set the identifier of the local fax station. Available since : Asterisk 12.
	Member	Get/Set the name of the member's interface. (Inherited from AbstractAgentEvent.)
	MemberName	Get/Set the name of the member's interface. (Inherited from AbstractAgentEvent.)
	PagesTransferred	Get/Set the number of pages transferred. Available since : Asterisk 12.
	Privilege	Get/Set the AMI authorization class of this event. This is one or more of system, call, log, verbose, command, agent or user. Multiple privileges are separated by comma. Note: This property is not available from Asterisk 1.0 servers. (Inherited from ManagerEvent.)
	Queue	Get/Set the name of the queue. (Inherited from AbstractAgentEvent.)
	RemoteStationId	Get/Set the identifier of the remote fax station. Available since : Asterisk 12.
	Resolution	Get/Set the row resolution of the received fax. Available since : Asterisk 12.
	Server	Specify a server to which to send your commands (x.x.x.x or hostname). 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. (Inherited from ManagerEvent.)
	Source	The ManagerConnection the Event was sourced from. (Inherited from ManagerEvent.)
	Timestamp	Returns the timestamp for this event. 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. (Inherited from ManagerEvent.)
	TransferRate	Get/Set the transfer rate in bits/s. Available since : Asterisk 12.
	UniqueId	Get/Set the unique id of the channel. (Inherited from ManagerEvent.)
	Variable	Obsolete. Get/Set the variables to set on the queue call in native asterisk format. Example: "VAR1=abc\|VAR2=def". (Inherited from AbstractAgentVariables.)

Top

Reference

AsterNET.Manager.Event Namespace