DN Interface

The superclass for all entities that have a real or virtual extension number. represents PBX endpoints (destination or source) for calls. Objects of this type hold the snapshot of internal object state.

Definition

Namespace: TCX.Configuration
Assembly: 3cxpscomcpp2 (in 3cxpscomcpp2.dll) Version: 20.0.1
C#
public interface DN : IOMStorable, IOMRemovable, 
	IOMSnapshot, IEquatable<Object>, ICalendarHolder, IDisposable, 
	IEquatable<DN>
Implements
IDisposable, IEquatableObject, IEquatableDN, ICalendarHolder, IOMRemovable, IOMSnapshot, IOMStorable

Properties

AddressNumberOrData0 Additional address info field 0
AddressNumberOrData1 Additional address info field 1
AddressNumberOrData2 Additional address info field 2
AddressNumberOrData3 Additional address info field 3
AddressNumberOrData4 Additional address info field 4
AddressNumberOrData5 Additional address info field 5
AddressNumberOrData6 Additional address info field 6
AddressNumberOrData7 Additional address info field 7
AddressNumberOrData8 Additional address info field 8
AddressNumberOrData9 Additional address info field 9
BreakTimeRouteDN 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
BreakTimeRoutePrompt prompt for break time route
BreakTimeRoutePromptEnabled Break time route prompt playback enabled
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)
ContactImage This url can be used to get image of the specific contact
DialCodePrefix [For future use] This DN is dialcode prefix.
GroupMembership The collection of GroupMember objects for all (Group) to which this DN belongs.
Groups The collection of administrative Groups (Group) to which this DN belongs.
Obsolete.
HasAttached Indicates that the object has attached data for saving transaction
(Inherited from IOMSnapshot)
HolidayInboundReferences Array of ExternalLineRule objects where this DN is referenced in HolidaysDestination
HolidaysActivity specifies activity of schedule during holidays
(Inherited from ICalendarHolder)
HolidaysRouteDN 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
HolidaysRoutePrompt Prompt for Holiday route
HolidaysRoutePromptEnabled Holiday route prompt playback enabled
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)
InOfficeInboundReferences Array of ExternalLineRule objects where this DN is referenced in OfficeHoursDestination
IsRegistered cumulative registration status. true - if at least one device is registered false otherwise
Number The number (physical or virtual) associated with this DN entity. Effectivelly it is internal unique identifier of the entity
OfficeHoursRouteDN 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
OfficeHoursRoutePrompt Prompt for office route (when no handled)
OfficeHoursRoutePromptEnabled Pffice hours route prompt playback enabled
OutOfOfficeHoursRouteDN 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
OutOfOfficeHoursRoutePrompt Prompt for out of office route
OutOfOfficeHoursRoutePromptEnabled Out of office hours route prompt playback enabled
OutOfOfficeInboundReferences Array of ExternalLineRule objects where this DN is referenced in OutOfOfficeHoursDestination
PhoneBookEntries Collection of phone book entries attached to the DN
Properties Collection of the custom properties
QueueMembership DN participation as a queue agent
RemovePrefixOnDelivery [For future use] Only if DialCodePrefix == true, Call Manager must remove prefix when send a call to DN (or SendTo
SendTo [For future use] This entity is shortcut to another destination
SystemDN If set to true,the DN is integral part of the system core. DN cannot be removed. Delete will fail.
VoiceMailBox voice mail box information see VMBInformation

Methods

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)
CreatePhoneBookEntry Creates a new PhoneBookEntry object attached to the DN (private phone book)
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.
FindContacts Personal phonebook lookup. Returns array of contacts matching specified caller id as described in FindContacts(String, UInt32)
GetActiveConnections Returns a set of ActiveConnection objects currently assotiated to this DN
GetHashCode Hash code is "record" identifier. So all snapshots of the object has the same hash.
(Inherited from IOMSnapshot)
GetPhoneBookEntries Collection of phone book entries attached to the DN
GetProperties The collection of custom properties for this DN.
GetPropertyByName(String) Returns a particular DN property given its name from persistent storage, or if not found.
GetPropertyByName(String, Boolean) Returns a particular DN property given its name from persistent storage or from local cache, or if not found.
GetPropertyValue returns actual value of named property in snapshot. returns values which was modified using SetProperty/DeleteProperty
GetQueues The set of Queue to which this DN belongs.
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
GetRegistrarContactsEx Returns a set of RegistrarRecord currently assotiated with DN
GetRingGroups The set of RingGroup to which this DN belongs.
GetTenant Returns the Tenant to which this DN object belongs.
Refresh Reverts all modifications (if any) and reloads object from configuration/realtime storage
(Inherited from IOMStorable)
ResetPrimaryGroup Resets current primary group.
Save Commits the changes. This method inserts new or update existing object in persistent storage.
(Inherited from IOMStorable)
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.
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.
ToString Brief description of object in term of Object model. default implementation is ToString. Concrete implementation may be more verbose.
(Inherited from IOMSnapshot)

Extension Methods

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)
ServiceCallAsyncServiceCallAsync(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)

See Also