public interface Group : DN, IOMStorable,
IOMRemovable, IOMSnapshot, IEquatable<Object>, ICalendarHolder,
IDisposable, IEquatable<DN>| AddressNumberOrData0 |
Additional address info field 0
(Inherited from DN) |
| AddressNumberOrData1 |
Additional address info field 1
(Inherited from DN) |
| AddressNumberOrData2 |
Additional address info field 2
(Inherited from DN) |
| AddressNumberOrData3 |
Additional address info field 3
(Inherited from DN) |
| AddressNumberOrData4 |
Additional address info field 4
(Inherited from DN) |
| AddressNumberOrData5 |
Additional address info field 5
(Inherited from DN) |
| AddressNumberOrData6 |
Additional address info field 6
(Inherited from DN) |
| AddressNumberOrData7 |
Additional address info field 7
(Inherited from DN) |
| AddressNumberOrData8 |
Additional address info field 8
(Inherited from DN) |
| AddressNumberOrData9 |
Additional address info field 9
(Inherited from DN) |
| AllowCallService | Default - false. Group does not provide calling service. (never registered on CallManager) |
| AnswerAfter | For future use. group perform autoanswer according to the needs of current destination. |
| BreakTime | Overrides dummy implementation provided in DN and provides storage for the break time schedule. |
| BreakTimeOperator |
BreakTime operator. The destination for the incoming calls during the time specified by BreakTime |
| BreakTimePrompt | Filename of the Breaktime prompt |
| BreakTimeRoute | DN may support time based redirection of the incoming calls
On break time, the calls will be sent to the destionation specified here.
The default destionationis ProceedWithNoExceptions (Inherited from DN) |
| BreakTimeRoutePrompt |
prompt for break time route
(Inherited from DN) |
| BreakTimeRoutePromptEnabled |
Break time route prompt playback enabled
(Inherited from DN) |
| CalendarHours |
Object which represent CalendarHoursType
(Inherited from ICalendarHolder) |
| CalendarHoursType |
Schedule hours can be changed without modification of the hours set. We don't need to update set of hours ranges each time when we update type of schedule
(Inherited from ICalendarHolder) |
| CallHandlingMode | Current CallHandling mode. NOT SUPPORTED. RESERVED FOR FUTURE USE. |
| ClosedHoursOperator |
Closed hours operator. The destination for the incoming calls during out of the time specified by Hours |
| ClosedHoursPrompt | Filename of the ClosedHours prompt |
| ContactImage |
This url can be used to get image of the specific contact
(Inherited from DN) |
| CurrentGroupHours | Current working hours mode. Could be use to enforce specific hours operator or override current operator. This setting is ignored after the time specified in OverrideExpiresAt. |
| CustomOperator | get/set current operator override. Operator which replaces current operatore for the time specified by CustomOperator |
| CustomPrompt | Filename of the custom prompt |
| DialCodePrefix |
[For future use] This DN is dialcode prefix.
(Inherited from DN) |
| DisableBreakTimePrompt | Disable Breaktime prompt |
| DisableClosedHoursPrompt | No prompt playback at closed hours. |
| DisableCustomPrompt | Disable opened hours prompt |
| DisableHolidayHoursPrompt | No prompt playback at holiday (don't answer call, simply redirect |
| DisableOpenedHoursPrompt | Disable opened hours prompt |
| GroupMembers | The set of the group members |
| GroupMembership |
The collection of GroupMember objects for all (Group) to which this DN belongs.
(Inherited from DN) |
| Groups |
The collection of administrative Groups (Group) to which this DN belongs.
(Inherited from DN) Obsolete. |
| HasAttached |
Indicates that the object has attached data for saving transaction
(Inherited from IOMSnapshot) |
| HolidayHoursOperator |
Holiday operator. The destination for the incoming calls during Holidays |
| HolidayHoursPrompt | Filename of the Holidays prompt |
| HolidayInboundReferences |
Array of ExternalLineRule objects where this DN is referenced in HolidaysDestination (Inherited from DN) |
| HolidaysActivity |
specifies activity of schedule during holidays
(Inherited from ICalendarHolder) |
| HolidaysRoute | DN may support time based redirection of the incoming calls
On holidays, the calls will be sent to the destionation specified here.
The default destionationis ProceedWithNoExceptions (Inherited from DN) |
| HolidaysRoutePrompt |
Prompt for Holiday route
(Inherited from DN) |
| HolidaysRoutePromptEnabled |
Holiday route prompt playback enabled
(Inherited from DN) |
| Hours |
Time schedule of when object is active. Interpretation of this data depends on the type of object. It can be OfficeTime, the time when specific routing rule is active etc.
(Inherited from ICalendarHolder) |
| ID |
each object has unique ID.
It is the same as the value returned by GetHashCode. (legacy)
new object has ID=0. After successful call to save snapshot gets persistent ID.
(Inherited from IOMSnapshot) |
| InboundCallerIDBlock | return all global of ibound caller id block entries |
| InOfficeInboundReferences |
Array of ExternalLineRule objects where this DN is referenced in OfficeHoursDestination (Inherited from DN) |
| IsRegistered |
cumulative registration status.
true - if at least one device is registered
false otherwise
(Inherited from DN) |
| Members |
The set of DN membership objects, representing the DNs that are members of this Group.
Obsolete. |
| Name | The unique name for this group. |
| Number |
The number (physical or virtual) associated with this DN entity.
Effectivelly it is internal unique identifier of the entity
(Inherited from DN) |
| OfficeHolidays | defined for automated backup serialization only. |
| OfficeHoursRoute | DN may support time based redirection of the incoming calls
At office time, the calls will be sent to the destionation specified here.
The default destionationis ProceedWithNoExceptions (Inherited from DN) |
| OfficeHoursRoutePrompt |
Prompt for office route (when no handled)
(Inherited from DN) |
| OfficeHoursRoutePromptEnabled |
Pffice hours route prompt playback enabled
(Inherited from DN) |
| OpenedHoursOperator |
Working hours operator. The destination for the incoming calls during the Hours except the time specified by BreakTime |
| OpenedHoursPrompt | Filename of the opened hours prompt |
| OutOfOfficeHoursRoute | DN may support time based redirection of the incoming calls
At out of office time, the calls will be sent to the destionation specified here.
The default destionationis ProceedWithNoExceptions (Inherited from DN) |
| OutOfOfficeHoursRoutePrompt |
Prompt for out of office route
(Inherited from DN) |
| OutOfOfficeHoursRoutePromptEnabled |
Out of office hours route prompt playback enabled
(Inherited from DN) |
| OutOfOfficeInboundReferences |
Array of ExternalLineRule objects where this DN is referenced in OutOfOfficeHoursDestination (Inherited from DN) |
| OverrideExpiresAt | The time until which the current overrides are applied. value is stored without Kind property and restored as a UTC date/time User code should also ignore Kind property and store/read this data as an "exact date and time in the group timezone" |
| OverridesHolidays | Future use: allows to declare group as "inherits main office holidays" Allow to have complete definition where: 1. separate schedule: OverridesHolidays=true; AND Schedule=SpecificHours[ExcludingHolidays]; 2. modified schedule: OverridesHolidays=true; OR Schedule=SpecificHours[ExcludingHolidays]; 3. transparent schedule: OverridesHolidays=false; AND Schedule=OfficeHours; |
| PhoneBookEntries |
Collection of phone book entries attached to the DN
(Inherited from DN) |
| Properties |
Collection of the custom properties
(Inherited from DN) |
| QueueMembership |
DN participation as a queue agent
(Inherited from DN) |
| RemovePrefixOnDelivery |
[For future use] Only if DialCodePrefix == true, Call Manager must remove prefix when send a call to DN (or SendTo (Inherited from DN) |
| Roles | roles defined for the group |
| SendTo |
[For future use] This entity is shortcut to another destination
(Inherited from DN) |
| SystemDN |
If set to true,the DN is integral part of the system core.
DN cannot be removed. Delete will fail.
(Inherited from DN) |
| VoiceMailBox |
voice mail box information see VMBInformation (Inherited from DN) |
| AttachOnSave(IEnumerableIOMSnapshot) |
This method allows to add other object updates to the main object saving transaction
(Inherited from IOMSnapshot) |
| AttachOnSave(IOMSnapshot) |
This method allows to add other object updates to the saving transaction of main object
(Inherited from IOMSnapshot) |
| Clone |
Makes fresh snapshot of the object without modifications
(Inherited from IOMSnapshot) |
| CreateGroupMember(DN) | Creates new instance of GroupMember associated with this group with default users membership |
| CreateGroupMember(DN, String) | Creates new instance of GroupMember associated with this group |
| CreateInboundCallerIDBlockEntry | Creates Group specific inbound caller id block endtry |
| CreateOfficeHoliday | Creates a new OfficeHoliday object for this group. |
| CreateOfficeHoliday(String, Byte, Byte, UInt16, NullableTimeSpan, Byte, Byte, UInt16, NullableTimeSpan) | Creates a new OfficeHoliday object for this group. |
| CreatePhoneBookEntry |
Creates a new PhoneBookEntry object attached to the DN (private phone book)
(Inherited from DN) |
| Delete |
Delete object from configuration database.
(Inherited from IOMRemovable) |
| DeleteOnSave(IEnumerableIOMSnapshot) |
Allows to remove other objects as a part of the main object saving transaction.
(Inherited from IOMSnapshot) |
| DeleteOnSave(IOMSnapshot) |
Allows to remove other objects as a part of the main object saving transaction.
(Inherited from IOMSnapshot) |
| DeleteProperty |
Removes property form list of DN properties. Changes are made to local cache. To store them into persistent storage, call Save method.
(Inherited from DN) |
| FindContacts |
Personal phonebook lookup. Returns array of contacts matching specified caller id as described in FindContacts(String, UInt32) (Inherited from DN) |
| get_RoleTagDescription |
returns description of role.
Object model stores description as a string.
Concrete format and interpretation of this data should be specified separatelly for each version of PBX.
Third party applications must not try to modify data of this property.
This field is reserved for internal use only
Obsolete. |
| GetActiveConnections |
Returns a set of ActiveConnection objects currently assotiated to this DN (Inherited from DN) |
| GetCurrentHoursModeOverride | Returns forced hours for specified time (if any) |
| GetHashCode |
Hash code is "record" identifier. So all snapshots of the object has the same hash.
(Inherited from IOMSnapshot) |
| GetOfficeHolidayFor | get holiday |
| GetOfficeHolidays | returns set of the holidays assigned to the group |
| GetPhoneBookEntries |
Collection of phone book entries attached to the DN
(Inherited from DN) |
| GetProperties |
The collection of custom properties for this DN.
(Inherited from DN) |
| GetPropertyByName(String) |
Returns a particular DN property given its name from persistent storage, or if not found.
(Inherited from DN) |
| GetPropertyByName(String, Boolean) |
Returns a particular DN property given its name from persistent storage or from local cache, or if not found.
(Inherited from DN) |
| GetPropertyValue |
returns actual value of named property in snapshot. returns values which was modified using SetProperty/DeleteProperty
(Inherited from DN) |
| GetQueues |
The set of Queue to which this DN belongs.
(Inherited from DN) |
| GetRegistrarContacts |
Returns a set of contacts currently assotiated with this DN
It is recommended to use GetRegistrarContactsEx which provides detailed information
about all contacts associated with DN
(Inherited from DN) |
| GetRegistrarContactsEx |
Returns a set of RegistrarRecord currently assotiated with DN (Inherited from DN) |
| GetRingGroups |
The set of RingGroup to which this DN belongs.
(Inherited from DN) |
| GetRoleDescription | description of the specific role |
| GetTenant |
Returns the Tenant to which this DN object belongs.
(Inherited from DN) |
| Refresh |
Reverts all modifications (if any) and reloads object from configuration/realtime storage
(Inherited from IOMStorable) |
| RemoveMembers |
removes members from the group. Call Save to store changes Call Refresh to revert all changes in group object. |
| ResetPrimaryGroup |
Resets current primary group.
(Inherited from DN) |
| RoleTags |
returns array of all roles available for group
Obsolete. |
| Save |
Commits the changes. This method inserts new or update existing object in persistent storage.
(Inherited from IOMStorable) |
| set_RoleTagDescription |
returns description of role.
Object model stores description as a string.
Concrete format and interpretation of this data should be specified separatelly for each version of PBX.
Third party applications must not try to modify data of this property.
This field is reserved for internal use only
Obsolete. |
| SetProperty(String, String) |
Adds new or updates existing property of DN, where PropertyType is String, and description is empty string. Changes are made to local cache. To store them into persistent storage, call Save method.
(Inherited from DN) |
| SetProperty(String, String, PropertyType, String) |
Adds new or updates existing property of DN. Changes are made to local cache. To store them into persistent storage, call Save method.
(Inherited from DN) |
| ToString |
Brief description of object in term of Object model.
default implementation is ToString. Concrete implementation may be more verbose.
(Inherited from IOMSnapshot) |
| UpsertMembers |
Inplace Add/Update of the members. This method does not store changes. Changes can be applied by calling Save. All changes made in Group can be reverted using Refresh method |
| NOAUTOANSWER | Infinite timeout for the answer. |
| BargeInCallbackAsync |
Call barge-in from the specific Extension. All devices of the Extension will be called.
(Defined by CallControlAPI) |
| Deserialize |
deserializes object and remenber repeatlist.
object can be saved
(Defined by SerializationExtension) |
| GetSerializableProperties |
Returns list of properties which are require serialization
(Defined by SerializationExtension) |
| GetTimeDestinationOverride |
providing full information about current time and time based routing destination for DN (Defined by CommonRoutingExtensions) |
| IsBreak |
Is now the breaktime for dn?
(Defined by CommonRoutingExtensions) |
| IsHoliday |
Is dnTime at the holiday for dn?
(Defined by CommonRoutingExtensions) |
| IsOffice |
Is now the office time for dn?
(Defined by CommonRoutingExtensions) |
| IsOutOfOffice |
Is now the out of office time for dn?
(Defined by CommonRoutingExtensions) |
| MakeCallAsync | (Defined by CallControlAPI) |
| Now |
Obtaining current time of the DN (Defined by CommonRoutingExtensions) |
| OMDelete |
Apply update of the specific snapshot.
virtually any object may be updated even those which are not supporting IOMStorable interface.
(Defined by CollectionTransactionsHelper) |
| OMSave |
Apply update of the specific snapshot.
virtually any object may be updated even those which are not supporting IOMStorable interface.
(Defined by CollectionTransactionsHelper) |
| PickupCallbackAsync |
Redirects replaces ringing replace_connection with the callback to the sendto device
(Defined by CallControlAPI) |
| SerializeObject |
Deserializer for IOMSnapshot
(Defined by SerializationExtension) |
| SerializeProperty |
returns false if there are no enough information at the moment and it should be repeated after after all objects will be restored.
Typical case is forward reference to the DN object.
(Defined by SerializationExtension) |
| ServiceCallAsync | ServiceCallAsync(RegistrarRecord, RPCParameters) (Defined by CallControlAPI) |
| TryDeserializeProperty |
returns false if there are no enough information at the moment and it should be repeated after after all objects will be restored.
Typical case is forward reference to the DN object.
(Defined by SerializationExtension) |