Class PortBundleEntry

Namespace

SWConfigDataClientLib.Proxies.PortBundle

Assembly

IpPbxCDSClientLib.dll

PortBundleEntry is the entry class for the Primary Configuration Item PortBundle (TrunkGroup). The class contains properties for each item attribute and collection of sub configuration items. Sub items:

public class PortBundleEntry : PortBundleEntryBase

Inheritance

object

SObject

SUpdateObject

PortBundleEntryBase

PortBundleEntry

Inherited Members

PortBundleEntryBase.ClassTrace

PortBundleEntryBase.Update(bool)

PortBundleEntryBase.SetAccessPrefixNull()

PortBundleEntryBase.SetDescriptionNull()

PortBundleEntryBase.SetOutBoundCalledNumberConversionNull()

PortBundleEntryBase.SetOutBoundCallingNumberConversionNull()

PortBundleEntryBase.SetInBoundCalledNumberConversionNull()

PortBundleEntryBase.SetInBoundCallingNumberConversionNull()

PortBundleEntryBase.SetMasterPBXPublicAccessPrefixNull()

PortBundleEntryBase.ApplyData(PortBundleEntry)

PortBundleEntryBase.ValidateNotNullMembers()

PortBundleEntryBase.SetDefaultValues()

PortBundleEntryBase.ToString()

PortBundleEntryBase.Clone()

PortBundleEntryBase.Verbose()

PortBundleEntryBase.Dispose()

PortBundleEntryBase.ProxyNumber

PortBundleEntryBase.RoutedNumberEntryCollection

PortBundleEntryBase.PortEntryCollection

PortBundleEntryBase.PortBundleLineOutNumReplEntryCollection

PortBundleEntryBase.PortBundleParameterEntryCollection

PortBundleEntryBase.PortBundleID

PortBundleEntryBase.IsPortBundleIDNull

PortBundleEntryBase.LocationID

PortBundleEntryBase.IsLocationIDNull

PortBundleEntryBase.ProfileID

PortBundleEntryBase.IsProfileIDNull

PortBundleEntryBase.Name

PortBundleEntryBase.IsNameNull

PortBundleEntryBase.EnableLCR

PortBundleEntryBase.IsEnableLCRNull

PortBundleEntryBase.AccessPrefix

PortBundleEntryBase.IsAccessPrefixNull

PortBundleEntryBase.ProviderSettingsName

PortBundleEntryBase.IsProviderSettingsNameNull

PortBundleEntryBase.CustomProviderSettingsEnabled

PortBundleEntryBase.IsCustomProviderSettingsEnabledNull

PortBundleEntryBase.ProviderID

PortBundleEntryBase.IsProviderIDNull

PortBundleEntryBase.PortBundleType

PortBundleEntryBase.IsPortBundleTypeNull

PortBundleEntryBase.Description

PortBundleEntryBase.IsDescriptionNull

PortBundleEntryBase.OutBoundCalledNumberConversion

PortBundleEntryBase.IsOutBoundCalledNumberConversionNull

PortBundleEntryBase.OutBoundCallingNumberConversion

PortBundleEntryBase.IsOutBoundCallingNumberConversionNull

PortBundleEntryBase.InBoundCalledNumberConversion

PortBundleEntryBase.IsInBoundCalledNumberConversionNull

PortBundleEntryBase.InBoundCallingNumberConversion

PortBundleEntryBase.IsInBoundCallingNumberConversionNull

PortBundleEntryBase.EnableCallRecording

PortBundleEntryBase.IsEnableCallRecordingNull

PortBundleEntryBase.MasterPBXPublicAccessPrefix

PortBundleEntryBase.IsMasterPBXPublicAccessPrefixNull

SObject.MakeKey(string)

SObject.SObjectID

Constructors

PortBundleEntry()

standard constructor

public PortBundleEntry()

Properties

DTMFMode

<CDSClient.ParameterProp>SIPDTMFMode</CDSClient.ParameterProp> Configures one of the possible DTMF transmission types used over SIP.

public SIPDTMFMode DTMFMode { get; set; }

Property Value

SIPDTMFMode

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

ProviderEncryptionMode

<CDSClient.ParameterProp>ProviderEncryptionMode</CDSClient.ParameterProp> Configures one of the possible Provider Encryption Modes.

public ProviderEncryptionMode ProviderEncryptionMode { get; set; }

Property Value

ProviderEncryptionMode

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPNumberFormat

<CDSClient.ParameterProp>SIPNumberFormat</CDSClient.ParameterProp>

public SIPNumberFormat SIPNumberFormat { get; set; }

Property Value

SIPNumberFormat

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPOutboundProxyName

<CDSClient.ParameterProp>SIPOutboundProxyName</CDSClient.ParameterProp> Name or address of SIP outbound proxy.

public string SIPOutboundProxyName { get; set; }

Property Value

string

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPOutboundProxyPort

<CDSClient.ParameterProp>SIPOutboundProxyPort</CDSClient.ParameterProp> SIP port on which the configured outbound proxy receives SIP messages.

public int SIPOutboundProxyPort { get; set; }

Property Value

int

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPProxyName

<CDSClient.ParameterProp>SIPProxyName</CDSClient.ParameterProp> Name or address of SIP proxy.

public string SIPProxyName { get; set; }

Property Value

string

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPProxyPort

<CDSClient.ParameterProp>SIPProxyPort</CDSClient.ParameterProp> SIP port on which the configured proxy receives SIP messages.

public int SIPProxyPort { get; set; }

Property Value

int

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPRealm

<CDSClient.ParameterProp>SIPRealm</CDSClient.ParameterProp> Defines the SIP realm e.g. of a SIP provider.

public string SIPRealm { get; set; }

Property Value

string

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPRegistrarEnable

<CDSClient.ParameterProp>SIPRegistrarEnable</CDSClient.ParameterProp> Flag to enable usage of the SIP registrar for SIP registration.

public bool SIPRegistrarEnable { get; set; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPRegistrarInterval

<CDSClient.ParameterProp>SIPRegistrarInterval</CDSClient.ParameterProp> The re-registration interval defines how often the registration at the SIP registrar will be updated.

public int SIPRegistrarInterval { get; set; }

Property Value

int

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPRegistrarName

<CDSClient.ParameterProp>SIPRegistrarName</CDSClient.ParameterProp> Name or address of SIP registrar. REGISTER messages are sent to this address.

public string SIPRegistrarName { get; set; }

Property Value

string

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPRegistrarPort

<CDSClient.ParameterProp>SIPRegistrarPort</CDSClient.ParameterProp> SIP port on which the configured registrar receives SIP messages.

public int SIPRegistrarPort { get; set; }

Property Value

int

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPSTUNEnable

<CDSClient.ParameterProp>SIPSTUNEnable</CDSClient.ParameterProp> Flag to enable STUN support for SIP.

public bool SIPSTUNEnable { get; set; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPSTUNServerName

<CDSClient.ParameterProp>SIPSTUNServerName</CDSClient.ParameterProp> Name or address of the STUN server for SIP.

public string SIPSTUNServerName { get; set; }

Property Value

string

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SIPSTUNServerPort

<CDSClient.ParameterProp>SIPSTUNServerPort</CDSClient.ParameterProp> Port on which the configured STUN server receives STUN messages.

public int SIPSTUNServerPort { get; set; }

Property Value

int

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

SipTransportType

<CDSClient.ParameterProp>SipTransportType</CDSClient.ParameterProp> Configures one of the possible Sip transport types.

public SipTransportType SipTransportType { get; set; }

Property Value

SipTransportType

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isDTMFModeNull

<CDSClient.GetParameterNull>SIPDTMFMode</CDSClient.GetParameterNull>

public bool isDTMFModeNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isProviderEncryptionModeNull

<CDSClient.GetParameterNull>ProviderEncryptionMode</CDSClient.GetParameterNull>

public bool isProviderEncryptionModeNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPNumberFormatNull

<CDSClient.GetParameterNull>SIPNumberFormat</CDSClient.GetParameterNull>

public bool isSIPNumberFormatNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPOutboundProxyNameNull

<CDSClient.GetParameterNull>SIPOutboundProxyName</CDSClient.GetParameterNull>

public bool isSIPOutboundProxyNameNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPOutboundProxyPortNull

<CDSClient.GetParameterNull>SIPOutboundProxyPort</CDSClient.GetParameterNull>

public bool isSIPOutboundProxyPortNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPProxyNameNull

<CDSClient.GetParameterNull>SIPProxyName</CDSClient.GetParameterNull>

public bool isSIPProxyNameNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPProxyPortNull

<CDSClient.GetParameterNull>SIPProxyPort</CDSClient.GetParameterNull>

public bool isSIPProxyPortNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPRealmNull

<CDSClient.GetParameterNull>SIPRealm</CDSClient.GetParameterNull>

public bool isSIPRealmNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPRegistrarEnableNull

<CDSClient.GetParameterNull>SIPRegistrarEnable</CDSClient.GetParameterNull>

public bool isSIPRegistrarEnableNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPRegistrarIntervalNull

<CDSClient.GetParameterNull>SIPRegistrarInterval</CDSClient.GetParameterNull>

public bool isSIPRegistrarIntervalNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPRegistrarNameNull

<CDSClient.GetParameterNull>SIPRegistrarName</CDSClient.GetParameterNull>

public bool isSIPRegistrarNameNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPRegistrarPortNull

<CDSClient.GetParameterNull>SIPRegistrarPort</CDSClient.GetParameterNull>

public bool isSIPRegistrarPortNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPSTUNEnableNull

<CDSClient.GetParameterNull>SIPSTUNEnable</CDSClient.GetParameterNull>

public bool isSIPSTUNEnableNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPSTUNServerNameNull

<CDSClient.GetParameterNull>SIPSTUNServerName</CDSClient.GetParameterNull>

public bool isSIPSTUNServerNameNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSIPSTUNServerPortNull

<CDSClient.GetParameterNull>SIPSTUNServerPort</CDSClient.GetParameterNull>

public bool isSIPSTUNServerPortNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

isSipTransportTypeNull

<CDSClient.GetParameterNull>SipTransportType</CDSClient.GetParameterNull>

public bool isSipTransportTypeNull { get; }

Property Value

bool

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

Methods

GetLineOutNumRepls()

Retrieves the PortBundles LineOutNumberReplacements

public PortBundleLineOutNumReplEntryCollection GetLineOutNumRepls()

Returns

PortBundleLineOutNumReplEntryCollection

Collection of LineOutNumberReplacements

Exceptions

UserDbException

On database failure

GetRoutedNumbers()

Retrieves the PortBundles RoutedNumbers

public RoutedNumberEntryCollection GetRoutedNumbers()

Returns

RoutedNumberEntryCollection

Collection of RoutedNumbers

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

SetLineOutNumRepls(PortBundleLineOutNumReplEntryCollection)

Sets LineOutNumRepls. This function writes the data straight into the database. There's no need to call Update(true).

public void SetLineOutNumRepls(PortBundleLineOutNumReplEntryCollection lineOutNumRepls)

Parameters

lineOutNumRepls PortBundleLineOutNumReplEntryCollection

Collection of LineOutNumberReplacements

Exceptions

UserDbException

On database failure

SetRoutedNumbers(RoutedNumberEntryCollection)

Sets RoutedNumbers. This function writes the data straight into the database. There's no need to call Update(true).

public void SetRoutedNumbers(RoutedNumberEntryCollection RoutedNumbers)

Parameters

RoutedNumbers RoutedNumberEntryCollection

List of Signal Relations for this User

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

setDTMFModeNull()

<CDSClient.SetParameterNull>SIPDTMFMode</CDSClient.SetParameterNull>

public void setDTMFModeNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setProviderEncryptionModeNull()

<CDSClient.SetParameterNull>ProviderEncryptionMode</CDSClient.SetParameterNull>

public void setProviderEncryptionModeNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setProviderProfile(ProviderProfileEntry)

Sets all parameters defined in the profile into the PortBundeEntry. This method should be used after selecting the ProviderProfile.

public void setProviderProfile(ProviderProfileEntry providerProfileEntry)

Parameters

providerProfileEntry ProviderProfileEntry

The ProviderProfileEntry selected.

setSIPNumberFormatNull()

<CDSClient.SetParameterNull>SIPNumberFormat</CDSClient.SetParameterNull>

public void setSIPNumberFormatNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPOutboundProxyNameNull()

<CDSClient.SetParameterNull>SIPOutboundProxyName</CDSClient.SetParameterNull>

public void setSIPOutboundProxyNameNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPOutboundProxyPortNull()

<CDSClient.SetParameterNull>SIPOutboundProxyPort</CDSClient.SetParameterNull>

public void setSIPOutboundProxyPortNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPProxyNameNull()

<CDSClient.SetParameterNull>SIPProxyName</CDSClient.SetParameterNull>

public void setSIPProxyNameNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPProxyPortNull()

<CDSClient.SetParameterNull>SIPProxyPort</CDSClient.SetParameterNull>

public void setSIPProxyPortNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPRealmNull()

<CDSClient.SetParameterNull>SIPRealm</CDSClient.SetParameterNull>

public void setSIPRealmNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPRegistrarEnableNull()

<CDSClient.SetParameterNull>SIPRegistrarEnable</CDSClient.SetParameterNull>

public void setSIPRegistrarEnableNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPRegistrarIntervalNull()

<CDSClient.SetParameterNull>SIPRegistrarInterval</CDSClient.SetParameterNull>

public void setSIPRegistrarIntervalNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPRegistrarNameNull()

<CDSClient.SetParameterNull>SIPRegistrarName</CDSClient.SetParameterNull>

public void setSIPRegistrarNameNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPRegistrarPortNull()

<CDSClient.SetParameterNull>SIPRegistrarPort</CDSClient.SetParameterNull>

public void setSIPRegistrarPortNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPSTUNEnableNull()

<CDSClient.SetParameterNull>SIPSTUNEnable</CDSClient.SetParameterNull>

public void setSIPSTUNEnableNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPSTUNServerNameNull()

<CDSClient.SetParameterNull>SIPSTUNServerName</CDSClient.SetParameterNull>

public void setSIPSTUNServerNameNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSIPSTUNServerPortNull()

<CDSClient.SetParameterNull>SIPSTUNServerPort</CDSClient.SetParameterNull>

public void setSIPSTUNServerPortNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>

setSipTransportTypeNull()

<CDSClient.SetParameterNull>SipTransportType</CDSClient.SetParameterNull>

public void setSipTransportTypeNull()

Remarks

<CDSClient.Enum.MatchingPortBundleType></CDSClient.Enum.MatchingPortBundleType>