org.asteriskjava.manager.event

Class FaxReceivedEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.AbstractFaxEvent

org.asteriskjava.manager.event.FaxReceivedEvent

All Implemented Interfaces:

Serializable

public class FaxReceivedEvent
extends AbstractFaxEvent

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$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
FaxReceivedEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getCallerId() Returns the Caller*ID of the calling party or an empty string if none is available.
String	getFilename() Returns the filename of the received fax including its full path on the Asterisk server.
String	getLocalStationId() Returns the identifier of the local fax station.
Integer	getPagesTransferred() Returns the number of pages transferred.
String	getRemoteStationId() Retruns the identifier of the remote fax station.
Integer	getResolution() Returns the row resolution of the received fax.
Integer	getTransferRate() Returns the transfer rate in bits/s.
void	setCallerId(String callerId) Sets the Caller*ID of the calling party.
void	setFilename(String filename) Sets the filename of the received fax.
void	setLocalStationId(String localStationId) Sets the identifier of the local fax station.
void	setPagesTransferred(Integer pagesTransferred) Sets the number of pages transferred.
void	setRemoteStationId(String remoteStationId) Sets the identifier of the remote fax station.
void	setResolution(Integer resolution) Sets the row resolution of the received fax.
void	setTransferRate(Integer transferRate) Sets the transfer rate in bits/s.

Methods inherited from class org.asteriskjava.manager.event.AbstractFaxEvent

getChannel, getFaxSession, setChannel, setFaxSession

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, setTimestamp, 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(Object source)

Method Detail

getCallerId

public 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(String callerId)

Sets the Caller*ID of the calling party.

Parameters:

callerId - the Caller*ID of the calling party.

getRemoteStationId

public String getRemoteStationId()

Retruns the identifier of the remote fax station.

Returns:

the identifier of the remote fax station.

setRemoteStationId

public void setRemoteStationId(String remoteStationId)

Sets the identifier of the remote fax station.

Parameters:

remoteStationId - the identifier of the remote fax station.

getLocalStationId

public String getLocalStationId()

Returns the identifier of the local fax station.

Returns:

the identifier of the local fax station.

setLocalStationId

public void setLocalStationId(String localStationId)

Sets the identifier of the local fax station.

Parameters:

localStationId - the identifier of the local fax station.

getPagesTransferred

public Integer getPagesTransferred()

Returns the number of pages transferred.

Returns:

the number of pages transferred.

setPagesTransferred

public void setPagesTransferred(Integer pagesTransferred)

Sets the number of pages transferred.

Parameters:

pagesTransferred - the number of pages transferred.

getResolution

public Integer getResolution()

Returns the row resolution of the received fax.

Returns:

the row resolution of the received fax.

setResolution

public void setResolution(Integer resolution)

Sets the row resolution of the received fax.

Parameters:

resolution - the row resolution of the received fax.

getTransferRate

public Integer getTransferRate()

Returns the transfer rate in bits/s.

Returns:

the transfer rate in bits/s.

setTransferRate

public void setTransferRate(Integer transferRate)

Sets the transfer rate in bits/s.

Parameters:

transferRate - the transfer rate in bits/s.

getFilename

public 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(String filename)

Sets the filename of the received fax.

Parameters:

filename - the filename of the received fax