Packagecom.acapela.vaas.advanced
Classpublic class MessageManager
InheritanceMessageManager Inheritance flash.events.EventDispatcher

This class provides functions to manage the message stored by the service.


Public Methods
 MethodDefined by
  
deleteMessage(msgID:String, comment:String, timeOut:uint = 5000, where:String = ""):void
command function: this function will delete the sound from the main storage on the server and will activate a listening process to treate and dispatch the result to the appropriate callbacks.
MessageManager
  
notifyMessage(msgID:String, reason:String, comment:String, timeOut:uint = 5000, where:String = ""):void
command function: use this function to notify service manager (acapela or its customer) that there is an issue with a message.
MessageManager
Events
 EventSummaryDefined by
  
messageDeleted
Dispatched when a message was successfuly deleted.MessageManager
  
messageNotified
Dispatched when a message was successfuly notified.MessageManager
Public Constants
 ConstantDefined by
  CONTENT_ISSUE : String = "CONTENT"
[static] Content issus reason to notify a message.
MessageManager
  CONTENT_NOTIF_LOC : String = "CONTENT_NOTIF"
[static] Content notified location : storage location of the message notified for an inappropriate/illegal content.
MessageManager
  CT_BUG_NOTIF_LOC : String = "CT_BUG_NOTIF"
[static] Content bug notified location : storage location of the mispronunced message
MessageManager
  DEFAULT_LOC : String = ""
[static] Default location - will let the service choose the location message to save/delete/notify.
MessageManager
  DELETED_LOC : String = "DELETED"
[static] Deleted location : storage location of the deleted messages.
MessageManager
  MISC_BUG_NOTIF_LOC : String = "MISC_BUG_NOTIF"
[static] storage location of the message notified for another type of issue
MessageManager
  MISC_ISSUE : String = "MISC_ISSUE"
[static] misc issus reason to notify a message.
MessageManager
  SPEECH_ISSUE : String = "CT_BUG"
[static] speech issus reason to notify a message.
MessageManager
  UNSPECIFIED : String = ""
[static] Default reason.
MessageManager
Method detail
deleteMessage()method
public function deleteMessage(msgID:String, comment:String, timeOut:uint = 5000, where:String = ""):void

command function: this function will delete the sound from the main storage on the server and will activate a listening process to treate and dispatch the result to the appropriate callbacks. Result is exactly the same as reobtainSound. So you may receive the URL of the DELETED sound if you registered the corresponding callback, please make sure it will not cause some trouble.

Parameters
msgID:String — msgID : the String received by the msgIDGenerated callback as a result of the initial generation.
 
comment:String — comment : provide a string describing this operation context (reason, author, ...).
 
timeOut:uint (default = 5000) — timeOut : Optionnal. The duration in milliseconds that the component can wait for a server answer (5000ms = 5 secs by default).
 
where:String (default = "") — where : Optionnal. Suitable only when doing an advanced moderation of your service. Contact support for further details.
notifyMessage()method 
public function notifyMessage(msgID:String, reason:String, comment:String, timeOut:uint = 5000, where:String = ""):void

command function: use this function to notify service manager (acapela or its customer) that there is an issue with a message. will store the sound and the associated and will activate a listening process to treate and dispatch the result to the appropriate callbacks. Result is exactly the same as reobtainSound. So you may receive the URL of the NOTIFIED sound if you registered the corresponding callback, please make sure it will not cause some trouble.

Parameters
msgID:String — msgID : the String received by the msgIDGenerated callback as a result of the initial generation.
 
reason:String — reason : use one of the following predifined constant to give the reason of the notification: UNSPECIFIED, CONTENT, SPEECH_ISSUE, MISC_ISSUE
 
comment:String — comment : provide a string describing containing details about this operation(detailled reason, author, ...).
 
timeOut:uint (default = 5000) — timeOut : Optionnal. The duration in milliseconds that the component can wait for a server answer (5000ms = 5 secs by default).
 
where:String (default = "") — where : Optionnal. Suitable only when doing an advanced moderation of your service. Contact support for further details.
Event detail
messageDeletedevent 
Event object type: com.acapela.vaas.advanced.events.MessageEvent
MessageEvent.type property = com.acapela.vaas.advanced.events.MessageEvent.MESSAGE_DELETED

Dispatched when a message was successfuly deleted.

The MessageEvent.MESSAGE_DELETED constant defines the value of the type property of an messageDeleted event object.

This event has the following properties:
PropertyDescription
bubblesfalse
cancelablefalse
messageThe message to this event
targetThe MessageManager instance that generated it.

You can access to the corresponding Message instance using message property of this event.

messageNotifiedevent  
Event object type: com.acapela.vaas.advanced.events.MessageEvent
MessageEvent.type property = com.acapela.vaas.advanced.events.MessageEvent.MESSAGE_NOTIFIED

Dispatched when a message was successfuly notified.

The MessageEvent.MESSAGE_NOTIFIED constant defines the value of the type property of an messageNotified event object.

This event has the following properties:
PropertyDescription
bubblesfalse
cancelablefalse
messageThe message to this event
targetThe MessageManager instance that generated it.

You can access to the corresponding Message instance using message property of this event.

Constant detail
CONTENT_ISSUEconstant
public static const CONTENT_ISSUE:String = "CONTENT"

Content issus reason to notify a message. This message will be copied and notified in CONTENT_NOTIF_LOC storage location.

CONTENT_NOTIF_LOCconstant 
public static const CONTENT_NOTIF_LOC:String = "CONTENT_NOTIF"

Content notified location : storage location of the message notified for an inappropriate/illegal content.

CT_BUG_NOTIF_LOCconstant 
public static const CT_BUG_NOTIF_LOC:String = "CT_BUG_NOTIF"

Content bug notified location : storage location of the mispronunced message

DEFAULT_LOCconstant 
public static const DEFAULT_LOC:String = ""

Default location - will let the service choose the location message to save/delete/notify.

DELETED_LOCconstant 
public static const DELETED_LOC:String = "DELETED"

Deleted location : storage location of the deleted messages.

MISC_BUG_NOTIF_LOCconstant 
public static const MISC_BUG_NOTIF_LOC:String = "MISC_BUG_NOTIF"

storage location of the message notified for another type of issue

MISC_ISSUEconstant 
public static const MISC_ISSUE:String = "MISC_ISSUE"

misc issus reason to notify a message. This message will be copied and notified in MISC_BUG_NOTIF_LOC storage location.

SPEECH_ISSUEconstant 
public static const SPEECH_ISSUE:String = "CT_BUG"

speech issus reason to notify a message. This message will be copied and notified in CT_BUG_NOTIF_LOC storage location.

UNSPECIFIEDconstant 
public static const UNSPECIFIED:String = ""

Default reason.




All rights reserved to acapela group