Tenant Interface

Represents a tenant in the Phone System.

Definition

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

Properties

BreakTime Stores default office break time. (used in automated extension status switching etc.)
BreakTime property may reference this schedule. if BreakTime is configured with type OfficeHours the schedule of BreakTime should be taken from here.
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)
DN Serialization property. Collection of DNs
Groups Serialization property. Collection of Groups
HasAttached Indicates that the object has attached data for saving transaction
(Inherited from IOMSnapshot)
HolidaysActivity specifies activity of schedule during holidays
(Inherited from ICalendarHolder)
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
Name Unique name of tenant.
OfficeHolidays Serialization property. Collection of OfficeHolidays
OutboundRules Serialization property. Collection of OutboundRules
PhoneBookEntries Serialization property. Collection of phone book entries attached to the Tenant
Properties Serialization property. Collection of OfficeHolidays

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)
CreateConferencePlaceExtension Creates a new ConferencePlaceExtension object.
Obsolete.
CreateConferencePlaceExtension(String) Creates a new ConferencePlaceExtension object.
CreateExtension Creates a new Extension object.
Obsolete.
CreateExtension(String) Creates a new Extension object Creates initilize full set of default profiles. sets Current profile to Available and adds extension to DEFAULT group with users role.
CreateExternalLine(Gateway) Creates a new ExternalLine for the given Gateway object.
Obsolete.
CreateExternalLine(Gateway, String) Creates a new ExternalLine for the given Gateway object.
CreateFaxExtension Creates a new FaxExtension object.
Obsolete.
CreateFaxExtension(String) Creates a new FaxExtension object.
CreateGroup Creates a new Group object.
CreateGroup(String, IEnumerableRoleDescription, IDictionaryDN, String) Bulk creation of group
CreateInboundCallerIDBlockEntry Creates system wide inbound caller id block endtry
CreateIVR Create a new IVR (Digital Receptionist) entity for this tenant.
Obsolete.
CreateIVR(String) Create a new IVR (Digital Receptionist) entity for this tenant.
CreateOfficeHoliday Creates a new OfficeHoliday object for this tenant.
CreateOfficeHoliday(String, Byte, Byte, UInt16, NullableTimeSpan, Byte, Byte, UInt16, NullableTimeSpan) Creates a new OfficeHoliday object for this tenant.
CreateOrGetProperty this method allows to create or update tenant property in context of other transaction.
CreateOutboundRule Creates a new outbound rule for this tenant.
CreateParkExtension Creates a new ParkExtension object.
Obsolete.
CreateParkExtension(String) Creates a new ParkExtension object.
CreatePhoneBookEntry Creates a new PhoneBookEntry object attached to tenant. (global phone book)
CreateQueue Creates a new Queue object.
Obsolete.
CreateQueue(String) Creates a new Queue object.
CreateRingGroup Creates a new RingGroup object.
Obsolete.
CreateRingGroup(String) Creates a new RingGroup object.
CreateRoutePoint Creates a mew RoutePoint object
CreateSpecialMenu Creates a new SpecialMenu object.
Obsolete.
CreateSpecialMenu(String) Creates a new SpecialMenu object.
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 Tenant properties
FindContacts Provides array of PhoneBookEntry matching specified caller id in company phonebook
Use FindContacts(String, UInt32) to search in personal phone book. best match priority is:
1. all with exact match
otherwise
2. ended with specified number
otherwise
3. longest possible match of the tail which is not less then min_len
otherwise - empty array
GetActiveConnections Returns the set of current active connections in the phone system, for this tenant.
Obsolete.
GetConferencePlaceExtensions The list of conference place extensions for this tenant.
Obsolete.
GetDN The list of DNs for this tenant.
Obsolete.
GetExtensionGroups The list of extension groups for this tenant.
Obsolete.
GetExtensions The list of extensions for this tenant.
Obsolete.
GetExternalLines The list of external lines for this tenant.
Obsolete.
GetFaxExtensions The list of Fax extensions for this tenant.
Obsolete.
GetHashCode Hash code is "record" identifier. So all snapshots of the object has the same hash.
(Inherited from IOMSnapshot)
GetHolidayOfToday check for holiday
Obsolete.
GetIVRs The list of IVR extensions for this tenant.
Obsolete.
GetNextAvailableDN(String) returns unique dnName for the new object which begins with specified prefix.
GetNextAvailableDN(String, Int32) returns unique dnName for the new object which begins with specified prefix.
GetOfficeHolidayFor returns the holiday which is comfigured for specified time. This method is working similar to GetOfficeHolidayFor(DateTime)
GetOfficeHolidays Returns collection of office holidays.
GetOutboundRules Outbound rules, which determine which external lines to use for which calls.
Obsolete.
GetParkExtensions The list of park extensions for this tenant.
Obsolete.
GetPhoneBookEntries Collection of Phone Book entries.
GetProperties Collection of custom tenant properties.
GetPropertyByName(String) Returns a tenant property given its name, or if not found.
GetPropertyByName(String, Boolean) Returns a particular Tenant property given its name from persistent storage or from local cache, or if not found.
GetPropertyValue returns value of property or null if it is not defined.
GetQueues The list of queues for this tenant.
Obsolete.
GetRingGroups The list of ring groups for this tenant.
Obsolete.
GetSpecialMenus The list of special menu extensions for this tenant.
Obsolete.
IsHoliday Returns if given DateTimeOffset object is in holiday range
Refresh Reverts all modifications (if any) and reloads object from configuration/realtime storage
(Inherited from IOMStorable)
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 Tenant.
SetProperty(String, String, PropertyType, String) Adds new or updates existing property of Tenant.
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

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