Class wsc.MessageSummary
a sub-class of Notification that represents a message-summary type notification.
Constructor Attributes | Constructor Name and Description |
---|---|
Extended from the Notification class.
|
Method Attributes | Method Name and Description |
---|---|
Get the message account associated with the current message summary notification.
|
|
getMessageCounts(msgClassType)
Get a MessageCounts object for current message summary.
|
|
Return the waiting message status.
|
Class Detail
wsc.MessageSummary()
Extended from the Notification class. Created by MessageAlertPackage when a notification of the event type
message-summary is received.
Method Detail
{String}
getMessageAccount()
Get the message account associated with the current message summary notification.
- Returns:
- {String} Message account associated with the current message summary notification
{object}
getMessageCounts(msgClassType)
Get a MessageCounts object for current message summary.
- Parameters:
- {String} msgClassType
- String to indicate the message class type, such as "voice_message".
This message class type corresponds to the SIP notification message class type. It is the lower case style and all "-" are replaced by "_" of the message class type in the SIP notification.
For example, if there is a field "Voice-message" in the SIP notification from the SIP application, the client side web application should use "voice_message" as the parameter when calling this function to get the message count information.
- Returns:
- {object} MessageCounts contains the message count information of the
message class type in the parameter.
For example, if wsc.MessageSummary.getMessageCounts("voice_message") is called, an object containing the message count of "voice_message" is returned. Likewise, if "fax_message" is passed as a parameter, the returned object contains the message count of "fax_message".
{boolean}
isMessageWaiting()
Return the waiting message status.
- Returns:
- {boolean} If there is message waiting, return true, otherwise false.