| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|
mcs
|
+--mcs.RingingPref
public class RingingPref
RingingPref encapsulates the set of Identity preferences related to ringing the subscriber's device on termination attempts. RingingPrefs are provisionable and clonable.
Links:
Kernel Association Association Link
A RingingPref specifies multiple RingingDeviceSet instances. A RingingDeviceSet belongs to a single RingingPref.
Clone:
- yes - deep. The cloned RingingPref references a deep clone of each RingingDeviceSet.
Associates type:
composition
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Directed.
Supplier cardinality:
0..*
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
Custom properties
associates:
mcs.RingingDeviceSet
link:
composition
Kernel Association Association Link
The ringingSchedule represent the set of scheduled RingingProfiles associated with the Identity. When terminating to the Identity the ringing schedule is checked to determine if an appropriate RingingDeviceSet has been scheduled (based on the current call time). If no RingingDeviceSet is located/schedule than the default simring logic is applied.
Constraints:
-must be a valid RingingSchedule if ringingScheduledEnabled is true
Default:
- none
Clone:
- yes - deep. The cloned RingingPref refences a deep clone of the RingingSchedule
Associates type:
composition
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
0..1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
Custom properties
link:
composition
Generalization Generalization Link
RingingPref encapsulates the set of Identity preferences related to ringing the subscriber's device on termination attempts. RingingPrefs are provisionable and clonable.
| Nested Class Summary |
public class |
InProgressPolicy |
public class |
SubsequentDualModePolicy |
public class |
DualModeRingingPolicy |
| Field Summary |
private DualModeRingingPolicy |
|
DualModeRingingPolicy |
CELLULAR_ONLY |
DualModeRingingPolicy |
CELLULAR_THEN_WIFI |
DualModeRingingPolicy |
CELLULAR_THEN_WIFI_IF_PRESENT |
DualModeRingingPolicy |
WIFI_IF_PRESENT |
DualModeRingingPolicy |
WIFI_IF_PRESENT_THEN_CELLULAR |
DualModeRingingPolicy |
WIFI_ONLY |
DualModeRingingPolicy |
WIFI_THEN_CELLULAR |
private InProgressPolicy |
|
InProgressPolicy |
RING_ALL |
InProgressPolicy |
RING_IDLE_DEVICES |
InProgressPolicy |
RING_INPROGRESS_DEVICE |
private String |
|
private Collection |
|
|
|
private boolean |
|
private SubsequentDualModePolicy |
|
SubsequentDualModePolicy |
RING_INPROGRESS_ENDPOINT |
SubsequentDualModePolicy |
USE_DUAL_MODE_POLICY |
private DualModeRingingPolicy dualModeRingingPolicy
The dualModeRingingPolicy describes the rules for ringing dual mode devices. Valid policies are:
- WIFI_ONLY: only ring the WiFi Endpoint
- CELLULAR_ONLY: only attempt the cellular Endpoint
- WIFI_THEN_CELLULAR: first attempt the WiFi Endpoint, if it does not answer then attempt the cellular Endpoint
- WIFI_IF_PRESENT: attempt the WiFi if it is registered
- WIFI_IF_PRESENT_THEN_CELLULAR: attempt the WiFi if it is registered, if it does not answer then attempt the cellular Endpoint
- CELLULAR_THEN_WIFI: first attempt the cellular Endpoint if it does not answer attempt the WiFi Endpoint
- CELLULAR_THEN_WIFI_IF_PRESENT: first attempt the cellular Endpoint, if it does not answer then attempt the WiFi device if it is registered
Default:
- "WIFI_IF_PRESENT_THEN_CELLULAR"
Clone:
- yes, verbatim
Multiplicity:
1
private InProgressPolicy inProgressPolicy
The inProgressPolicy governs how the Identity's Endpoints should be attempted when a call termination is processed for a Subscriber that is already on a call. The valid policies are:
- RING_IDLE_DEVICES: ring all the Endpoints except the Endpoints that are associated with existing calls. This option is most useful when the Subscriber represents a group of individuals such that if one individual is on a call subsequent calls should alert only the other individuals.
- RING_INPROGRESS_DEVICE: ring only the Endpoint that is associated with the existing call. This is useful when the Subscriber is a single user and would like subsequent calls disposed to their active Endpoint such that they can invoke the network based hold mechanism.
- RING_ALL: ring all the Endpoints
Constraints:
"RING_IDLE_DEVICES" | "RING_INPROGRESS_DEVICE" | "RING_ALL"
Default:
- "RING_ALL"
Clone:
- yes, verbatim
Multiplicity:
1
private String ringbackAnnouncementUri
The ringbackAnnouncementUri attribute represents the URI of the announcement used to provide consistent ringing to caller during sim ring. The ringbackAnnouncementUri is a SIP URI pointing to a provisioned DN based announcement.
Constraints:
- see SipUri constraints
- must not be null if McsSubscriberPref.ringbackResourceType == URI
Default:
- none
Clone:
- yes, verbatim
Multiplicity:
1
private Collection ringingDeviceSets
A RingingPref specifies multiple RingingDeviceSet instances. A RingingDeviceSet belongs to a single RingingPref.
Clone:
- yes - deep. The cloned RingingPref references a deep clone of each RingingDeviceSet.
Multiplicity:
1
Custom properties
associates:
mcs.RingingDeviceSet
The ringingSchedule represent the set of scheduled RingingProfiles associated with the Identity. When terminating to the Identity the ringing schedule is checked to determine if an appropriate RingingDeviceSet has been scheduled (based on the current call time). If no RingingDeviceSet is located/schedule than the default simring logic is applied.
Constraints:
-must be a valid RingingSchedule if ringingScheduledEnabled is true
Default:
- none
Clone:
- yes - deep. The cloned RingingPref refences a deep clone of the RingingSchedule
Multiplicity:
1
private boolean ringingScheduleEnabled
ringingScheduleEnable flag indicates whether (TRUE) the ringingSchedule should be applied to call terminations or (FALSE) whether the default treatment (SIMRING) should be applied.
Constraints:
- true | false
Default:
- false
Clone:
- yes, verbatim
Multiplicity:
1
private SubsequentDualModePolicy subsequentDualModePolicy
subsequentDualModePolicy defines how calls should be disposed to dual mode devices that are already in progress with existing calls. The valid policies are:
- RING_INPROGRESS_ENDPOINT: dispose the call to the same Endpoint on which
the call has progressed
- USE_DUAL_MODE_POLICY: apply the DualModePolicy in order to determine
which of the two Endpoints to ring.
Constraints:
- "RING_INPROGRESS_ENDPOINT" | "USE_DUAL_MODE_POLICY"
Default:
- "RING_INPROGRESS_ENDPOINT"
Clone:
- yes, verbatim
Multiplicity:
1
| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|