org.asteriskjava.manager.event

Class VoicemailUserEntryEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.ResponseEvent

org.asteriskjava.manager.event.VoicemailUserEntryEvent

All Implemented Interfaces:

Serializable

public class VoicemailUserEntryEvent
extends ResponseEvent

A VoicemailUserEntryCompleteEvent is triggered in response to a VoicemailUsersListAction and contains the details about a voicemail user.

It is implemented in apps/app_voicemail.c
Available since Asterisk 1.6

Since:

1.0.0

Version:

$Id$

Author:

srt

See Also:

VoicemailUserEntryCompleteEvent, VoicemailUsersListAction, Serialized Form

Field Summary

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

actionId

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
VoicemailUserEntryEvent(Object source) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
String	getAttachmentFormat()
Boolean	getAttachMessage() Returns whether Asterisk copies a voicemail message to an audio file and sends it to the user as an attachment in an eemail voicemail notification message.
String	getCallback() Returns the dialplan context used by the "return phone call" feature in the advanced voicemail features menu.
Boolean	getCallOperator()
Boolean	getCanReview()
Boolean	getDeleteMessage() Returns whether messages will be deleted from the voicemailbox (after having been emailed).
String	getDialout() Returns the dialplan context used by the "place an outgoing call" feature in the advanced voicemail features menu.
String	getEmail() Returns the email address of the voicemail user.
String	getExitContext() Returns the dialplan context the user is dropped into after he has pressed * or 0 to exit voicemail.
String	getFullname() Returns the full name of the voicemail user that is used for the directory application.
String	getImapUser() Returns the username of the IMAP account associated with this mailbox.
String	getLanguage()
String	getMailCommand() Returns the custom mail command used to send notifications to the voicemail user.
Integer	getMaxMessageCount() Returns the maximum number of messages per folder.
Integer	getMaxMessageLength() Returns the maximum duration per message for voicemails in this mailbox.
Integer	getNewMessageCount()
Integer	getOldMessageCount() Returns the number of old ("read" or listened to) messages for this voicemail user.
String	getPager() Returns the email adress of pager of the voicemail user.
Boolean	getSayCid()
Integer	getSayDurationMinimum()
Boolean	getSayEnvelope()
String	getServerEmail() Returns the email address used for the "from" header when sending notification emails.
String	getTimezone()
String	getUniqueId()
String	getVmContext() Returns the voicemail context.
String	getVoicemailbox() Returns the mailbox id.
Double	getVolumeGain() Returns the volume gain used for voicemails sent via email.
void	setAttachmentFormat(String attachmentFormat)
void	setAttachMessage(Boolean attachMessage) Sets whether Asterisk copies a voicemail message to an audio file and sends it to the user as an attachment in an eemail voicemail notification message.
void	setCallback(String callback) Sets the dialplan context used by the "return phone call" feature in the advanced voicemail features menu.
void	setCallOperator(Boolean callOperator)
void	setCanReview(Boolean canReview)
void	setDeleteMessage(Boolean deleteMessage) Sets whether messages will be deleted from the voicemailbox (after having been emailed).
void	setDialout(String dialout) Sets the dialplan context used by the "place an outgoing call" feature in the advanced voicemail features menu.
void	setEmail(String email) Sets the email address of the voicemail user.
void	setExitContext(String exitContext) Sets the dialplan context the user is dropped into after he has pressed * or 0 to exit voicemail.
void	setFullname(String fullname) Sets the full name of the voicemail user.
void	setImapUser(String imapUser) Sets the username of the IMAP account associated with this mailbox.
void	setLanguage(String language)
void	setMailCommand(String mailCommand) Sets the custom mail command used to send notifications to the voicemail user.
void	setMaxMessageCount(Integer maxMessageCount) Sets the maximum number of messages per folder.
void	setMaxMessageLength(Integer maxMessageLength) Returns the maximum duration per message for voicemails in this mailbox.
void	setNewMessageCount(Integer newMessageCount)
void	setOldMessageCount(Integer oldMessageCount) Sets the number of old messages for this voicemail user.
void	setPager(String pager) Sets the email adress of pager of the voicemail user.
void	setSayCid(Boolean sayCid)
void	setSayDurationMinimum(Integer sayDurationMinimum)
void	setSayEnvelope(Boolean sayEnvelope)
void	setServerEmail(String serverEmail) Sets the email address used for the "from" header when sending notification emails.
void	setTimezone(String timezone)
void	setUniqueId(String uniqueId)
void	setVmContext(String vmContext) Sets the voicemail context.
void	setVoicemailbox(String voicemailbox) Sets the mailbox id.
void	setVolumeGain(Double volumeGain) Sets the volume gain used for voicemails sent via email.

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

getActionId, getInternalActionId, setActionId, setInternalActionId

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

VoicemailUserEntryEvent

public VoicemailUserEntryEvent(Object source)

Creates a new instance.

Parameters:

source -

Method Detail

getVmContext

public String getVmContext()

Returns the voicemail context.

Returns:

the voicemail context.

setVmContext

public void setVmContext(String vmContext)

Sets the voicemail context.

Parameters:

vmContext - the voicemail context.

getVoicemailbox

public String getVoicemailbox()

Returns the mailbox id. The mailbox is unique within the voicemail context.

Returns:

the mailbox id.

setVoicemailbox

public void setVoicemailbox(String voicemailbox)

Sets the mailbox id.

Parameters:

voicemailbox - the mailbox id.

getFullname

public String getFullname()

Returns the full name of the voicemail user that is used for the directory application.

Returns:

the full name of the voicemail user.

setFullname

public void setFullname(String fullname)

Sets the full name of the voicemail user.

Parameters:

fullname - the full name of the voicemail user.

getEmail

public String getEmail()

Returns the email address of the voicemail user.

Returns:

the email address of the voicemail user.

setEmail

public void setEmail(String email)

Sets the email address of the voicemail user.

Parameters:

email - the email address of the voicemail user.

getPager

public String getPager()

Returns the email adress of pager of the voicemail user. This email will not receive attachments.

Returns:

the email adress of pager of the voicemail user.

setPager

public void setPager(String pager)

Sets the email adress of pager of the voicemail user.

Parameters:

pager - the email adress of pager of the voicemail user.

getServerEmail

public String getServerEmail()

Returns the email address used for the "from" header when sending notification emails.

Returns:

the email address used for the "from" header when sending notification emails.

setServerEmail

public void setServerEmail(String serverEmail)

Sets the email address used for the "from" header when sending notification emails.

Parameters:

serverEmail - the email address used for the "from" header when sending notification emails.

getMailCommand

public String getMailCommand()

Returns the custom mail command used to send notifications to the voicemail user.

Returns:

the custom mail command used to send notifications to the voicemail user.

setMailCommand

public void setMailCommand(String mailCommand)

Sets the custom mail command used to send notifications to the voicemail user.

Parameters:

mailCommand - the custom mail command used to send notifications to the voicemail user.

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)

getTimezone

public String getTimezone()

setTimezone

public void setTimezone(String timezone)

getCallback

public String getCallback()

Returns the dialplan context used by the "return phone call" feature in the advanced voicemail features menu.

Returns:

the dialplan context used by the "return phone call" feature in the advanced voicemail features menu.

setCallback

public void setCallback(String callback)

Sets the dialplan context used by the "return phone call" feature in the advanced voicemail features menu.

Parameters:

callback - the dialplan context used by the "return phone call" feature in the advanced voicemail features menu.

getDialout

public String getDialout()

Returns the dialplan context used by the "place an outgoing call" feature in the advanced voicemail features menu.

Returns:

the dialplan context used by the "place an outgoing call" feature in the advanced voicemail features menu.

setDialout

public void setDialout(String dialout)

Sets the dialplan context used by the "place an outgoing call" feature in the advanced voicemail features menu.

Parameters:

dialout - the dialplan context used by the "place an outgoing call" feature in the advanced voicemail features menu.

getUniqueId

public String getUniqueId()

setUniqueId

public void setUniqueId(String uniqueId)

getExitContext

public String getExitContext()

Returns the dialplan context the user is dropped into after he has pressed * or 0 to exit voicemail.

Returns:

the dialplan context the user is dropped into after he has pressed * or 0 to exit voicemail.

setExitContext

public void setExitContext(String exitContext)

Sets the dialplan context the user is dropped into after he has pressed * or 0 to exit voicemail.

Parameters:

exitContext - the dialplan context the user is dropped into after he has pressed * or 0 to exit voicemail.

getSayDurationMinimum

public Integer getSayDurationMinimum()

setSayDurationMinimum

public void setSayDurationMinimum(Integer sayDurationMinimum)

getSayEnvelope

public Boolean getSayEnvelope()

setSayEnvelope

public void setSayEnvelope(Boolean sayEnvelope)

getSayCid

public Boolean getSayCid()

setSayCid

public void setSayCid(Boolean sayCid)

getAttachMessage

public Boolean getAttachMessage()

Returns whether Asterisk copies a voicemail message to an audio file and sends it to the user as an attachment in an eemail voicemail notification message.

Returns:

Booelan.TRUE if message will be attached, Boolean.FALSE if not, null if unset.

setAttachMessage

public void setAttachMessage(Boolean attachMessage)

Sets whether Asterisk copies a voicemail message to an audio file and sends it to the user as an attachment in an eemail voicemail notification message.

Parameters:

attachMessage - Booelan.TRUE if message will be attached, Boolean.FALSE if not, null if unset.

getAttachmentFormat

public String getAttachmentFormat()

setAttachmentFormat

public void setAttachmentFormat(String attachmentFormat)

getDeleteMessage

public Boolean getDeleteMessage()

Returns whether messages will be deleted from the voicemailbox (after having been emailed).

Returns:

Booelan.TRUE if messages will be deleted from the voicemailbox, Boolean.FALSE if not, null if unset.

setDeleteMessage

public void setDeleteMessage(Boolean deleteMessage)

Sets whether messages will be deleted from the voicemailbox (after having been emailed).

Parameters:

deleteMessage - Booelan.TRUE if messages will be deleted from the voicemailbox, Boolean.FALSE if not.

getVolumeGain

public Double getVolumeGain()

Returns the volume gain used for voicemails sent via email.

Returns:

the volume gain used for voicemails sent via email.

setVolumeGain

public void setVolumeGain(Double volumeGain)

Sets the volume gain used for voicemails sent via email.

Parameters:

volumeGain - the volume gain used for voicemails sent via email.

getCanReview

public Boolean getCanReview()

setCanReview

public void setCanReview(Boolean canReview)

getCallOperator

public Boolean getCallOperator()

setCallOperator

public void setCallOperator(Boolean callOperator)

getMaxMessageCount

public Integer getMaxMessageCount()

Returns the maximum number of messages per folder. 0 indicated unlimited.

Returns:

the maximum number of messages per folder or 0 for unlimited.

setMaxMessageCount

public void setMaxMessageCount(Integer maxMessageCount)

Sets the maximum number of messages per folder.

Parameters:

maxMessageCount - the maximum number of messages per folder.

getMaxMessageLength

public Integer getMaxMessageLength()

Returns the maximum duration per message for voicemails in this mailbox.

Returns:

the maximum duration in seconds.

setMaxMessageLength

public void setMaxMessageLength(Integer maxMessageLength)

Returns the maximum duration per message for voicemails in this mailbox.

Parameters:

maxMessageLength - the maximum duration in seconds.

getNewMessageCount

public Integer getNewMessageCount()

setNewMessageCount

public void setNewMessageCount(Integer newMessageCount)

getOldMessageCount

public Integer getOldMessageCount()

Returns the number of old ("read" or listened to) messages for this voicemail user.

This property is only available if the IMAP storage backend is used.

Returns:

the number of old messages for this voicemail user.

setOldMessageCount

public void setOldMessageCount(Integer oldMessageCount)

Sets the number of old messages for this voicemail user.

Parameters:

oldMessageCount - the number of old messages for this voicemail user.

getImapUser

public String getImapUser()

Returns the username of the IMAP account associated with this mailbox.

This property is only available if the IMAP storage backend is used.

Returns:

the username of the IMAP account associated with this mailbox.

setImapUser

public void setImapUser(String imapUser)

Sets the username of the IMAP account associated with this mailbox.

Parameters:

imapUser - the username of the IMAP account associated with this mailbox.