BlackListEntry Interface

Entry of the IP black list

Definition

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

Properties

AddedBy Who add it and who should manage it. "0"(or empty)- administrator of PBX using ManagementConsole, "1" - whitelist for MCU servers, "2" - whitelist for Webmeeting servers, "3" - blacklist downloaded from 3CX site, "4" - added by MC Whitelist feature
BlockType type of block. if set to 0 - This IP is blocked. (default value)
if set to 1 - This IP always allowed. (should not be automatically blocked) by any component
Description description of the entry.
ExpiresAt the entry is valid until this time
HasAttached Indicates that the object has attached data for saving transaction
(Inherited from IOMSnapshot)
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)
IPAddr blacklisted IP. In combination with IPMask may specify subnets.
IPMask if the entry specifies single IP, mask should be specified as "255.255.255.255". In combination with IPAddr may specify subnets

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)
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)
GetHashCode Hash code is "record" identifier. So all snapshots of the object has the same hash.
(Inherited from IOMSnapshot)
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)
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