net.sf.asterisk.manager.event
Class FaxReceivedEvent

java.lang.Object
  java.util.EventObject
      net.sf.asterisk.manager.event.ManagerEvent
          net.sf.asterisk.manager.event.AbstractAgentEvent
              net.sf.asterisk.manager.event.FaxReceivedEvent

All Implemented Interfaces:

java.io.Serializable

public class FaxReceivedEvent
extends AbstractAgentEvent

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.

Since:

0.2

Version:

$Id: FaxReceivedEvent.java,v 1.1 2005/10/26 06:39:30 srt Exp $

Author:

srt

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

FaxReceivedEvent(java.lang.Object source)

Method Summary

java.lang.String	getCallerId() Returns the Caller*ID of the calling party or an empty string if none is available.
java.lang.String	getChannel() Returns the name of the channel the fax has been recieved on.
java.lang.String	getExten() Returns the extension in Asterisk's dialplan the fax was received through.
java.lang.String	getFilename() Returns the filename of the received fax including its full path on the Asterisk server.
java.lang.String	getLocalStationId() Returns the identifier of the local fax station.
java.lang.Integer	getPagesTransferred() Returns the number of pages transferred.
java.lang.String	getRemoteStationId() Retruns the identifier of the remote fax station.
java.lang.Integer	getResolution() Returns the row resolution of the received fax.
java.lang.Integer	getTransferRate() Returns the transfer rate in bits/s.
void	setCallerId(java.lang.String callerId) Sets the Caller*ID of the calling party.
void	setChannel(java.lang.String channel) Sets the name of the channel the fax has been recieved on.
void	setExten(java.lang.String exten) Sets the extension the fax was received through.
void	setFilename(java.lang.String filename) Sets the filename of the received fax.
void	setLocalStationId(java.lang.String localStationId) Sets the identifier of the local fax station.
void	setPagesTransferred(java.lang.Integer pagesTransferred) Sets the number of pages transferred.
void	setRemoteStationId(java.lang.String remoteStationId) Sets the identifier of the remote fax station.
void	setResolution(java.lang.Integer resolution) Sets the row resolution of the received fax.
void	setTransferRate(java.lang.Integer transferRate) Sets the transfer rate in bits/s.

Methods inherited from class net.sf.asterisk.manager.event.AbstractAgentEvent

getMember, getQueue, getUniqueId, setMember, setQueue, setUniqueId

Methods inherited from class net.sf.asterisk.manager.event.ManagerEvent

getDateReceived, getPrivilege, setDateReceived, setPrivilege, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FaxReceivedEvent

public FaxReceivedEvent(java.lang.Object source)

Method Detail

getChannel

public java.lang.String getChannel()

Returns the name of the channel the fax has been recieved on.

Overrides:

getChannel in class AbstractAgentEvent

Returns:

the name of the channel the fax has been recieved on.

setChannel

public void setChannel(java.lang.String channel)

Sets the name of the channel the fax has been recieved on.

Overrides:

setChannel in class AbstractAgentEvent

Parameters:

channel - the name of the channel the fax has been recieved on.

getExten

public java.lang.String getExten()

Returns the extension in Asterisk's dialplan the fax was received through.

Returns:

the extension the fax was received through.

setExten

public void setExten(java.lang.String exten)

Sets the extension the fax was received through.

Parameters:

exten - the extension the fax was received through.

getCallerId

public java.lang.String getCallerId()

Returns the Caller*ID of the calling party or an empty string if none is available.

Returns:

the Caller*ID of the calling party.

setCallerId

public void setCallerId(java.lang.String callerId)

Sets the Caller*ID of the calling party.

Parameters:

callerId - the Caller*ID of the calling party.

getRemoteStationId

public java.lang.String getRemoteStationId()

Retruns the identifier of the remote fax station.

Returns:

the identifier of the remote fax station.

setRemoteStationId

public void setRemoteStationId(java.lang.String remoteStationId)

Sets the identifier of the remote fax station.

Parameters:

remoteStationId - the identifier of the remote fax station.

getLocalStationId

public java.lang.String getLocalStationId()

Returns the identifier of the local fax station.

Returns:

the identifier of the local fax station.

setLocalStationId

public void setLocalStationId(java.lang.String localStationId)

Sets the identifier of the local fax station.

Parameters:

localStationId - the identifier of the local fax station.

getPagesTransferred

public java.lang.Integer getPagesTransferred()

Returns the number of pages transferred.

Returns:

the number of pages transferred.

setPagesTransferred

public void setPagesTransferred(java.lang.Integer pagesTransferred)

Sets the number of pages transferred.

Parameters:

pagesTransferred - the number of pages transferred.

getResolution

public java.lang.Integer getResolution()

Returns the row resolution of the received fax.

Returns:

the row resolution of the received fax.

setResolution

public void setResolution(java.lang.Integer resolution)

Sets the row resolution of the received fax.

Parameters:

resolution - the row resolution of the received fax.

getTransferRate

public java.lang.Integer getTransferRate()

Returns the transfer rate in bits/s.

Returns:

the transfer rate in bits/s.

setTransferRate

public void setTransferRate(java.lang.Integer transferRate)

Sets the transfer rate in bits/s.

Parameters:

transferRate - the transfer rate in bits/s.

getFilename

public java.lang.String getFilename()

Returns the filename of the received fax including its full path on the Asterisk server.

Returns:

the filename of the received fax

setFilename

public void setFilename(java.lang.String filename)

Sets the filename of the received fax.

Parameters:

filename - the filename of the received fax