Asterisk-Java

org.asteriskjava.manager.event
Class VoicemailUserEntryEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.asteriskjava.manager.event.ManagerEvent
          extended by org.asteriskjava.manager.event.ResponseEvent
              extended by org.asteriskjava.manager.event.VoicemailUserEntryEvent
All Implemented Interfaces:
java.io.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: VoicemailUserEntryEvent.java 948 2008-01-30 03:09:42Z srt $
Author:
srt
See Also:
VoicemailUserEntryCompleteEvent, VoicemailUsersListAction, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
VoicemailUserEntryEvent(java.lang.Object source)
          Creates a new instance.
 
Method Summary
 java.lang.String getAttachmentFormat()
           
 java.lang.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.
 java.lang.String getCallback()
          Returns the dialplan context used by the "return phone call" feature in the advanced voicemail features menu.
 java.lang.Boolean getCallOperator()
           
 java.lang.Boolean getCanReview()
           
 java.lang.Boolean getDeleteMessage()
          Returns whether messages will be deleted from the voicemailbox (after having been emailed).
 java.lang.String getDialout()
          Returns the dialplan context used by the "place an outgoing call" feature in the advanced voicemail features menu.
 java.lang.String getEmail()
          Returns the email address of the voicemail user.
 java.lang.String getExitContext()
          Returns the dialplan context the user is dropped into after he has pressed * or 0 to exit voicemail.
 java.lang.String getFullname()
          Returns the full name of the voicemail user that is used for the directory application.
 java.lang.String getImapUser()
          Returns the username of the IMAP account associated with this mailbox.
 java.lang.String getLanguage()
           
 java.lang.String getMailCommand()
          Returns the custom mail command used to send notifications to the voicemail user.
 java.lang.Integer getMaxMessageCount()
          Returns the maximum number of messages per folder.
 java.lang.Integer getMaxMessageLength()
          Returns the maximum duration per message for voicemails in this mailbox.
 java.lang.Integer getNewMessageCount()
           
 java.lang.Integer getOldMessageCount()
          Returns the number of old ("read" or listened to) messages for this voicemail user.
 java.lang.String getPager()
          Returns the email adress of pager of the voicemail user.
 java.lang.Boolean getSayCid()
           
 java.lang.Integer getSayDurationMinimum()
           
 java.lang.Boolean getSayEnvelope()
           
 java.lang.String getServerEmail()
          Returns the email address used for the "from" header when sending notification emails.
 java.lang.String getTimezone()
           
 java.lang.String getUniqueId()
           
 java.lang.String getVmContext()
          Returns the voicemail context.
 java.lang.String getVoicemailbox()
          Returns the mailbox id.
 java.lang.Double getVolumeGain()
          Returns the volume gain used for voicemails sent via email.
 void setAttachmentFormat(java.lang.String attachmentFormat)
           
 void setAttachMessage(java.lang.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(java.lang.String callback)
          Sets the dialplan context used by the "return phone call" feature in the advanced voicemail features menu.
 void setCallOperator(java.lang.Boolean callOperator)
           
 void setCanReview(java.lang.Boolean canReview)
           
 void setDeleteMessage(java.lang.Boolean deleteMessage)
          Sets whether messages will be deleted from the voicemailbox (after having been emailed).
 void setDialout(java.lang.String dialout)
          Sets the dialplan context used by the "place an outgoing call" feature in the advanced voicemail features menu.
 void setEmail(java.lang.String email)
          Sets the email address of the voicemail user.
 void setExitContext(java.lang.String exitContext)
          Sets the dialplan context the user is dropped into after he has pressed * or 0 to exit voicemail.
 void setFullname(java.lang.String fullname)
          Sets the full name of the voicemail user.
 void setImapUser(java.lang.String imapUser)
          Sets the username of the IMAP account associated with this mailbox.
 void setLanguage(java.lang.String language)
           
 void setMailCommand(java.lang.String mailCommand)
          Sets the custom mail command used to send notifications to the voicemail user.
 void setMaxMessageCount(java.lang.Integer maxMessageCount)
          Sets the maximum number of messages per folder.
 void setMaxMessageLength(java.lang.Integer maxMessageLength)
          Returns the maximum duration per message for voicemails in this mailbox.
 void setNewMessageCount(java.lang.Integer newMessageCount)
           
 void setOldMessageCount(java.lang.Integer oldMessageCount)
          Sets the number of old messages for this voicemail user.
 void setPager(java.lang.String pager)
          Sets the email adress of pager of the voicemail user.
 void setSayCid(java.lang.Boolean sayCid)
           
 void setSayDurationMinimum(java.lang.Integer sayDurationMinimum)
           
 void setSayEnvelope(java.lang.Boolean sayEnvelope)
           
 void setServerEmail(java.lang.String serverEmail)
          Sets the email address used for the "from" header when sending notification emails.
 void setTimezone(java.lang.String timezone)
           
 void setUniqueId(java.lang.String uniqueId)
           
 void setVmContext(java.lang.String vmContext)
          Sets the voicemail context.
 void setVoicemailbox(java.lang.String voicemailbox)
          Sets the mailbox id.
 void setVolumeGain(java.lang.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, getDateReceived, getFile, getFunc, getLine, getPrivilege, getSequenceNumber, getServer, getTimestamp, setDateReceived, setFile, setFunc, setLine, setPrivilege, setSequenceNumber, setServer, 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(java.lang.Object source)
Creates a new instance.

Parameters:
source -
Method Detail

getVmContext

public java.lang.String getVmContext()
Returns the voicemail context.

Returns:
the voicemail context.

setVmContext

public void setVmContext(java.lang.String vmContext)
Sets the voicemail context.

Parameters:
vmContext - the voicemail context.

getVoicemailbox

public java.lang.String getVoicemailbox()
Returns the mailbox id. The mailbox is unique within the voicemail context.

Returns:
the mailbox id.

setVoicemailbox

public void setVoicemailbox(java.lang.String voicemailbox)
Sets the mailbox id.

Parameters:
voicemailbox - the mailbox id.

getFullname

public java.lang.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(java.lang.String fullname)
Sets the full name of the voicemail user.

Parameters:
fullname - the full name of the voicemail user.

getEmail

public java.lang.String getEmail()
Returns the email address of the voicemail user.

Returns:
the email address of the voicemail user.

setEmail

public void setEmail(java.lang.String email)
Sets the email address of the voicemail user.

Parameters:
email - the email address of the voicemail user.

getPager

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String language)

getTimezone

public java.lang.String getTimezone()

setTimezone

public void setTimezone(java.lang.String timezone)

getCallback

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getUniqueId()

setUniqueId

public void setUniqueId(java.lang.String uniqueId)

getExitContext

public java.lang.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(java.lang.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 java.lang.Integer getSayDurationMinimum()

setSayDurationMinimum

public void setSayDurationMinimum(java.lang.Integer sayDurationMinimum)

getSayEnvelope

public java.lang.Boolean getSayEnvelope()

setSayEnvelope

public void setSayEnvelope(java.lang.Boolean sayEnvelope)

getSayCid

public java.lang.Boolean getSayCid()

setSayCid

public void setSayCid(java.lang.Boolean sayCid)

getAttachMessage

public java.lang.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(java.lang.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 java.lang.String getAttachmentFormat()

setAttachmentFormat

public void setAttachmentFormat(java.lang.String attachmentFormat)

getDeleteMessage

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.Boolean getCanReview()

setCanReview

public void setCanReview(java.lang.Boolean canReview)

getCallOperator

public java.lang.Boolean getCallOperator()

setCallOperator

public void setCallOperator(java.lang.Boolean callOperator)

getMaxMessageCount

public java.lang.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(java.lang.Integer maxMessageCount)
Sets the maximum number of messages per folder.

Parameters:
maxMessageCount - the maximum number of messages per folder.

getMaxMessageLength

public java.lang.Integer getMaxMessageLength()
Returns the maximum duration per message for voicemails in this mailbox.

Returns:
the maximum duration in seconds.

setMaxMessageLength

public void setMaxMessageLength(java.lang.Integer maxMessageLength)
Returns the maximum duration per message for voicemails in this mailbox.

Parameters:
maxMessageLength - the maximum duration in seconds.

getNewMessageCount

public java.lang.Integer getNewMessageCount()

setNewMessageCount

public void setNewMessageCount(java.lang.Integer newMessageCount)

getOldMessageCount

public java.lang.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(java.lang.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 java.lang.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(java.lang.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.

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.