Class
Tree
          
SUMMARY: INNER | FIELD | CONSTR | METHODDETAIL: FIELD | CONSTR | METHOD
 

mcs
Class MwiPref

public class MwiPref      
MwiPref encapsulates the Identity based message waiting indicator (MWI) handling preferences.
The MCS message waiting indicator (MWI) capability propagates MWI using one of two methods: call-based or unsolicited SIP NOTIFY.
Call-Based MWI Propagation:
When MCS receives an MWI indication describing that a new message is waiting it propagates it to PBX based devices by placing a call to the mwiOnUri which the PBX interprets by setting the MWI on the device (described in the call parameters). Similarly, when MCS receives an indication that the message(s) has been cleared it places a call to the mwiOffUri which the PBX interprets by clearing the MWI on the device (described in the call parameters).
Unsolicited SIP NOTIFY
Alternatively to call-based delivery, MCS may propagate MWI indication via SIP based unsolicited NOTIFY messages. MwiPrefs are provisionable and clonable.
 
 

Nested Class Summary
public class
MwiDeliveryType
Field Summary
private MwiDeliveryType
private String
MwiDeliveryType
CALL_BASED
MwiDeliveryType
UNSOLICITED
boolean
private String
private String
private String
Field Detail
deliveryType
private MwiDeliveryType deliveryType
deliveryType describes the mechanism used to propagate an MWI notification to the Subscriber handset. The valid options for deliveryType are:
- UNSOLICITED: MWI is propagated via unsolicited SIP event NOTIFY
- CALL_BASED: MWI is propagated by placing a call (INVITE) to a specified URI (e.g. CCM4) which will in turn manage the MWI indicator on the device
NOTE: in future the CSN may be extended to support SOLICITED notification
Constraints:
- "UNSOLICITED" | "CALL_BASED"
- must be assigned if mwiEnabled is true
Default:
- "UNSOLICITED"
Clone:
- yes, verbatim
Multiplicity:
1
 

device
private String device
The device attribute defines the Device to which the MWI indication should be propagated. If the assigned device is a dual mode device
than it is assumed that the delivery type for the cellular Endpoint is via SMPP. MWI is propagated to the WIFI side on the basis of the
deliveryType attribute. If the Device is single mode, MWI is propagated based on the deliveryType attribute.
Constraints:
- must be a valid Device (not null) if mwiEnabled is TRUE
- the Device.originatingIdentity == McsIdentityPref.identity
Default:
- none
Clone:
- yes - deep. The cloned MwiPref reference a deep clone of the Device (cloned device with same name)
Multiplicity:
1
 

mwiEnabled
boolean mwiEnabled
mwiEnabled is a flag that indicates whether (TRUE) the MWI propagation feature is enabled. If mwiEnabled indicates (FALSE) that the capability is disabled then MCS does not handle MWI propagation.
Constraints:
- true | false
Default:
- false
Clone:
- yes, verbatim
Multiplicity:
1
 

mwiOffUri
private String mwiOffUri
mwiOffUri represents the address to which a call is placed for CALL_BASED MWI propagation in order to clear the device MWI indicator. Will be used as Request-URI of SIP message.
Constraints:
- see Address constraints
- must be assigned if MwiPref.deliveryType == CALL_BASED
Default:
- none
Clone:
- yes, verbatim
Multiplicity:
1
 

mwiOnUri
private String mwiOnUri
mwiOnUri represents the address to which a call is placed for CALL_BASED MWI propagation in order to turn on the device MWI indicator. Will be used as Request-URI of SIP message.
Constraints:
- see Address constraints
- must be assigned if MwiPref.deliveryType == CALL_BASED
Default:
- none
Clone:
- yes, verbatim
Multiplicity:
1
 

outboundAddress
private String outboundAddress
outboundAddress represents the outbound address used in propagating MWI via the CALL_BASED deliveryType to either the mwiOnUri or mwiOffUri
Constraints:
- see Address constraints
- must be assigned if MwiPref.deliveryType == CALL_BASED
Default:
- none
Clone:
- yes, verbatim
Multiplicity:
1
 

Class
Tree
          
SUMMARY: INNER | FIELD | CONSTR | METHODDETAIL: FIELD | CONSTR | METHOD