TCX.Configuration Namespace

Configuration API

Classes

ArrayDisposerExtension Class for extension methods
CollectionTransactionsHelper Defines two common operations over IOMSnapshot collections
DestinationFreeStringSerializer Propery should not be serializaed/deserialized
DisposerExtensions Useful extensions for extracting from arrays of disposables
MalformedRolesException Thrown if Roles is assigned with malformed data
OMCallCollector 
OMCallCollectorActiveConnectionFields 
OMCallCollectorCall 
OMCallCollectorCallStateSnapshot 
OMCallCollectorCallStateSnapshotConnectionState 
OMClassSerializationData Provides list of properties and ClassName for serialization
ParameterExtension Extensions for parameter access
PhoneSystem PhoneSystem configuration
PhoneSystemInternalHeapStat For code debugging. Must not be used by third party applications.
PhoneSystemInternalStat For code debugging. Must not be used by third party applications.
PsArgsEventListener Generic temporary Event listener.
PsTypeEventListenerT typed listener some of the types are shared across dataclasses f.e. VMBOX, DN, REGISTRATION class is delivering DN object so by type - requires check of the DataClass. data class can be null. In this case = data class will not be verified DataClass==null any DataClass with specific object type., filter==null - any DataClass object of any type. all object which don't have the specified type will be delivered as null. DataClass==null, filter!=null - any DataClass object of specified type excluding nulls DataClass==<specific>, filter==null - specific DataClass object of specified type including other types DataClass==<specific>, filter!=null - specific DataClass object of specified type excluding null Example: To monitor Extension objects with dataclass "DN" (modification of class you can specify Extension as the object and set filtee to null.
RolesSerializerAttributeRoles serializer
Schedule Represents time schedule settings of different objects
SchedulePeriodOfDay structure which holds information about "period of day"
SchedulePeriodsOfDay collection of periods set for the day.
ScheduleSerializerAttribute Serializer attribute for the properties of Schedule type.
SerializationExtension Extension methods for deserialization
SerializationExtensionContext Serialization context.

Structures

DestinationStruct Simple implementation of the Destination.
NotificationEventArgs Encapsulates event parameters for record changes notification. events in
RoleDescription Role description.
RouteRequest Single reroute request
TCXLogEvent The report entry for ReportLogEvents
VMBInformation Brief information about Voice Mail Box Content

Interfaces

ActiveConnection Provides information about call participant
Announcement 
AudioFeed Audio stream (PlayList) object interface
AvailableRouting represents Available status routing
AwayRouting Represents away status profile routing
BlackListEntry Entry of the IP black list
CallTypeDestination destination based on Call type (AvailableRouting)
Codec Sanpshot of codec data
ConferencePlaceExtension Snapshot of ConferencePlaceExtension data
Destination routing destination
DeviceInfo Represents a SIP device which was detected by PBX object is read only. It cannot be updated but Delete procedure is available to cleanup storage.
DIDDestination represents set of destinations for Inbound rule (ForwardDestinations
DN 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.
DNProperty Represents a custom DN property.
DNRange Represents a range of DN numbers for use with OutboundRule.
DNRef Lightwaight reference to the DN object
in many cases, only brief information is required for the DN.
Extension Represents the set of configuration settings for a single, physical extension.
ExtensionRule Represents a forwarding rule, including the conditions and the destination.
ExternalLine Represents an external line.
ExternalLineRule Represents a forwarding rule, including the conditions and the destination.
FaxExtension Represents a Fax Extension.
FwdProfile Definition of the Extension status profile
This object specifies how calls addressed to the extension should be handled.
For further information see CurrentProfile and CurrentProfileOverride
Gateway Represents a Gateway entity (base interface for VoipProvider)
GatewayParameter Represents a configurable Gateway Parameter.
GatewayParameterBinding Represents a Gateway Parameter assigned to a Gateway Value.
GatewayParameterValue Represents a value that can be assigned to a Gateway Parameter.
Group Represents a group of extensions managed by a tenant as a single unit.
GroupMember Group membership object
HoursDestination split by hours (AwayRouting)
HoursRange Represents a range of office hours for a particular day of the week.
IArrayDisposerT IArrayDisposer interface.
ICalendarHolder Common interface for Time scheduled objects.
InboundCallerIDBlockEntry Incoming CallerID block entry
IOMLookupTkey, Tobj Lookup interface
IOMRemovable Object can be deleted.
IOMSnapshot common interface for Object Model snapshot Object has
IOMStorable Object can be updated (added)
IOMTransaction The sequence of the updates which will be executed in requested sequence
IOMTransactionResult Provides additional information about transaction
IPhoneSystem 
IRegistrarStore This interface is allow to request registration information
IVR Represents an IVR entity in the phone system.
IVRForward Identifies the behaviour of forwarding from one menu to another, or on timeout.
MediaStatsData CallManager provides this data for all currently monitored calls, corresponding updates are delivered as "MEDIASTATS" notification NotificationEventArgs
OfficeHoliday Represents an instance of an office holiday. can be specified as single day (DayEnd, MonthEnd is 0) (backward compatible with previous versions)
OutboundRoute Represents an outbound route, used in conjunction with OutboundRule.
OutboundRule Represents an outbound rule.
Parameter Represents a global parameter for the phone system.
ParkExtension Represents a park extension entity, as a specialization of a DN class. Two extensions must be configured in the system to get the parking orbit functionality Behavior of ParkExtension depends on Parameters "PARK" and "UNPARK"
PhoneBookEntry Represents a Phone Book entry.
PhoneDevice Represents a phone device associated with a particular extension.
PhoneModel Represents a phone model supported by the PBX.
PhoneSystemILog 
Prompt Represets a single prompt in PromptSet
PromptSet Represents a collection of prompts in some particular language.
Queue Represents a queue entity in the phone system.
QueueAgent Agent of the Queue
QueueManager A member of Queue management group
RegistrarRecord Snapshot of registrar record.
RingGroup Represents a Ring Group entity in the phone system.
RoutePoint RoutePoint object
RuleCallType Represents a call source-based condition for a rule.
RuleCondition Represents a condition for a rule.
RuleConditionGroup Represents the three type of conditions that must be true for a forwarding rule to apply.
RuleHours Represents a time-based condition for a rule.
SbcRuntimeData CallManager provides this data for all currently connected SBCs, corresponding updates are delivered as "SBCRUNTIMEDATA" notification NotificationEventArgs
SpecialMenu Represents a DN of type Special Menu.
Statistics Storage of statistics data
Tenant Represents a tenant in the Phone System.
TenantProperty Represents a custom Tenant property.
TrunkRegTimes CallManager provides this data as explanation of the trunk registration process The updates are delivered as "TRUNKREGTIMES" notifications NotificationEventArgs
VoipProvider Extended Gateway interface for VoIP Provider objects

Delegates

NotificationEventHandler Update notifications handler
OMCallCollectorReloadedHandler 
OMCallCollectorRemovedHandler Removed handler
OMCallCollectorUpdatedHandler UpdatedHandler called each time when state of the call has been updated.
PsTypeEventListenerTDeleteEventHandler object has been removed
PsTypeEventListenerTUpsertEventHandler Update/Insert event delegate
SerializationExtensionContextAdjuster type of the method for AdjustHandler

Enumerations

AnnouncementType Announcement playback type
AudioFeedType Type of the stream
BusyDetectionType Set of options for type of Busy Detection mechanism.
CallHandlingFlags Group operation mode.
Group may be configered to operate like
ConnectionStatus Status of ActiveConnection
DestinationType type of destination for routing rules
DirectionType Determines which direction calls can be made from this line.
FaxBehaviorType Determines which calls from this line are fax calls.
GatewayType Identifies the type of gateway.
GroupHoursMode Treatment of current time ForceCustomOperator can be combited with any "time treatment" flag So, treatment of time can be combined with overwriting the current operator.
HolidaysHandling Defines how to treat holidays with the schedule
IPInRegistrationContactType types of IP which can be used by PBX to register VoIP line
IVRForwardType Identifies the behaviour of forwarding from one menu to another, or on timeout.
MatchingStrategyType Identifies the type of matching strategy to be used to identify calls from this gateway.
OMCallCollectorCallStateSnapshotCallState 
OMCallCollectorConnectionCapabilities Capabilities
OMCallCollectorDnType Type of the DN
OMCallCollectorLocalConnectionState 
ParameterType The possible types that field Parameter in class Parameter can represent.
PhoneSystemDataSubsets Specifies different sets of data which will be provided by ObjectModel it doesn't restrict ability to create objects.
PhoneSystemDropRingingAction the action which will be applied if connection is terminated using "CANCEL" method (device is ringing)
PhoneSystemLogEventEntryType Type of mesage reported to PBX event log.
PhoneSystemPasswordGenerationOptions Password generation options
PollingStrategyType Agent polling strategy
PromptSetType Type of prompt set.
PropertyType Determines the type in which field DNProperty in class DNProperty should be interpreted.
QueueStatusType Set of options for the extenion's queue status.
RecordingAction actions for Recording method
RequireRegistrationForType Identifies what type of registration is required for a gateway.
RoutingType returns type of the routing
RuleCallTypeType Identifies the type of the rule call type.
RuleConditionType Identifies the type of the rule condition.
RuleHoursType Interpretation of the schedule.
SRTPModeType SRTP handling types
StrategyType Type of calling strategy for RingGroup
UpdateOperation the opcode for update notifications.
UserStatusType Set of options for user availibility.
VMEmailOptionsType Set of options for Voice Mail e-mailing.
VMPlayMsgDateTimeType Set of options for Voice Mail date playback.