Gateway Interface

Represents a Gateway entity (base interface for VoipProvider)

Definition

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

Properties

Codecs The collection of codecs required for this gateway.
DeliverAudio Specifies whether PBX should deliver audio for this gateway.
DestNumberInRemotePartyIDCalled Whether destination number should be in the 'RemotePartyID;party=called' SIP header field.
DestNumberInRequestLineURI Whether destination number should be in the 'Request-Line-URI' SIP header field.
DestNumberInTo Whether destination number should be in the 'To.user' SIP header field.
EnableSRTP Controls whether the PABX Media Server should accept/propose secure RTP media stream from/to this gateway (provider).
Obsolete.
HasAttached Indicates that the object has attached data for saving transaction
(Inherited from IOMSnapshot)
Host Gateway host.
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)
InboundParams Advanced Inbound Gateway parameters to configure which SIP message fields will contain which information.
Internal Specifies whether gateway is internal.
Lines Number of ports on this gateway.
MatchingStrategy Which matching strategy to use to identify incoming calls from this provider.
Name The user-assigned name for this gateway.
OutboundCallerID The Outbound Caller ID for this gateway.
OutboundParams Advanced Outbound Gateway parameters to configure which SIP message fields will contain which information.
Port Gateway port number.
RequireRegistrationFor Identifies whether this gateway requires registration, and if it does, on which direction of calls.
SourceIdentification Returns the set of SIP Fields and their values used to identify incoming calls from this provider.
SRTPMode Supersedes EnableSRTP. Allows to set optional and mandatory usage of SRTP
SupportReinvite Allows SIP server to use Reinvite procedures with the gateway. if set to , SIP server will not use Reinvite with the device after call is established.
SupportReplaces Allows SIP server to use 'Replaces' header when communicating with this Gateway. If set to , SIP server will apply SIP procedures which are not using SIP 'Replaces' header
TemplateFilename The filename representing the template for this gateway.
Type Identifies the type of the gateway.
UseIPInContact Identifies whether the option "Use registration's 'Contact' field host/port instead host/port specified in configuration" is checked or not.
VariableChoices A map that stores custom variable choices for the gateway (depends on the template file associated with the gateway).

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)
CreateGatewayParameterBinding Creates a new instance of GatewayParameterBinding to be added to SourceIdentification, InboundParams or OutboundParams.
CreateGatewayParameterBinding(GatewayParameter, GatewayParameterValue, String) Creates initilized instance of GatewayParameterBinding
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)
GetExternalLines The lines associated with this gateway. The lines may belong to different tenants.
GetHashCode Hash code is "record" identifier. So all snapshots of the object has the same hash.
(Inherited from IOMSnapshot)
GetOutboundRules The outbound rules associated with this gateway. The lines may belong to different tenants.
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