Class PortBundleEnum

Namespace

SWConfigDataClientLib.Proxies.PortBundle

Assembly

IpPbxCDSClientLib.dll

<CDSClientLib.EnumSummary> PortBundleEntry PortBundleEnum</CDSClientLib.EnumSummary>

public class PortBundleEnum : PortBundleEnumBase, SEnum

Inheritance

object

SWCFProxy<PortBundleEnumClient, IPortBundleEnum>

SWCFEnum<PortBundleEnumClient, IPortBundleEnum>

PortBundleEnumBase

PortBundleEnum

Implements

SEnum

Inherited Members

PortBundleEnumBase._OrderByList

PortBundleEnumBase.ClassTrace

PortBundleEnumBase.objectList

PortBundleEnumBase.GetCurrentObject()

PortBundleEnumBase.GetExistingEntry(TPortBundleEnum.TPortBundleEntry)

PortBundleEnumBase.Update()

PortBundleEnumBase.Reload()

PortBundleEnumBase.Count()

PortBundleEnumBase.GetObjectByPrimaryKey(int)

PortBundleEnumBase.GetOrderByList()

PortBundleEnumBase.getValueLists(ValueLists)

PortBundleEnumBase.PrimaryCollection

Remarks

<CDSClientLib.EnumRemarks></CDSClientLib.EnumRemarks>

Constructors

PortBundleEnum()

Standard Constructor

public PortBundleEnum()

Properties

PoolMaxSize

depcreated

public static int PoolMaxSize { get; set; }

Property Value

int

PoolMinSize

depcreated

public static int PoolMinSize { get; set; }

Property Value

int

m_BaseUrl

protected override string m_BaseUrl { get; }

Property Value

string

Methods

AddRoutedNumbers(RoutedNumberEntryCollection)

Adds new Routing Records in a bulk operation

public void AddRoutedNumbers(RoutedNumberEntryCollection col)

Parameters

col RoutedNumberEntryCollection

Collection of new Routing Records

CheckVersion()

public void CheckVersion()

Clear()

Removes all itmes and filters, DataSet on server will be removed also

public override void Clear()

Remarks

The items will not be deleted in database.

CreateClient(Binding, EndpointAddress)

protected override PortBundleEnumClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

PortBundleEnumClient

DeleteRoutedNumbers(SIntList)

Deletes Routing Records in a bulk operation

public void DeleteRoutedNumbers(SIntList RoutedNumberIDs)

Parameters

RoutedNumberIDs SIntList

DeleteStaticPresharedKey(int)

Deletes the static PSK of the given Port(Trunk)

public bool DeleteStaticPresharedKey(int PortID)

Parameters

PortID int

ID of the Port(Trunk)

Returns

bool

True is successfull

Remarks

This method will change data in database.

Dispose()

<CDSClient.Enum.Dispose></CDSClient.Enum.Dispose>

public override void Dispose()

ExecuteAllFilter(OrderByList)

Sets filter on PortBunde to revieve all creates and executes SQL query on PortBundle table in configuration database

public void ExecuteAllFilter(OrderByList orderByList)

Parameters

orderByList OrderByList

Remarks

This is a remote method.

ExecuteIDFilter(int)

Sets filter on PortBunde by PortBundleID creates and executes SQL query on PortBundle table in configuration database

public void ExecuteIDFilter(int PortBundleID)

Parameters

PortBundleID int

The EntryID.

Remarks

This is a remote method.

ExecuteLocationIDFilter(int, OrderByList)

Sets filter on PortBunde by LocationID creates and executes SQL query on PortBundle table in configuration database

public void ExecuteLocationIDFilter(int LocationID, OrderByList orderByList)

Parameters

LocationID int

The LocationID.

orderByList OrderByList

the order by list

Remarks

This is a remote method.

ExecuteNameFilter(string, OrderByList)

Sets filter on PortBunde by LocationID creates and executes SQL query on PortBundle table in configuration database

public void ExecuteNameFilter(string name, OrderByList orderByList)

Parameters

name string

The name of the bundle.

orderByList OrderByList

the order by list

Remarks

This is a remote method.

ExecuteTypeFilter(PortBundleType, OrderByList)

public void ExecuteTypeFilter(PortBundleType portBundleType, OrderByList orderByList)

Parameters

portBundleType PortBundleType

orderByList OrderByList

FreeForReuse()

public override void FreeForReuse()

GetAllNumberFormatProfiles()

Retrieves all NumberFormatProfiles

public NumberProfilePrimaryCollection GetAllNumberFormatProfiles()

Returns

NumberProfilePrimaryCollection

Collection of NumberFormatProfiles objects.

GetAllProviderProfiles()

Retrieves all Provider Profiles

public ProviderProfilePrimaryCollection GetAllProviderProfiles()

Returns

ProviderProfilePrimaryCollection

Collection of ProviderProfileEntries.

GetAllTrunkInfos()

Returns information about all visible trunks. The visbility of a trunk depends on the administrative scope of the autheticated user. The System Administrator with system scope gets info all trunks. A Reseller Administrator gets info about all trunks of his tenants A tenant administrator gets all info about his own trunks.

public ICollection<TrunkInfo> GetAllTrunkInfos()

Returns

ICollection<TrunkInfo>

GetBotLinkInfoById(int)

public BotLinkInfo GetBotLinkInfoById(int routingEntryId)

Parameters

routingEntryId int

Returns

BotLinkInfo

GetBotLinkInfos()

public List<BotLinkInfo> GetBotLinkInfos()

Returns

List<BotLinkInfo>

GetBotLinkInfosList()

This method is here only for the unmanaged wrapper

public BotLinkInfoList GetBotLinkInfosList()

Returns

BotLinkInfoList

GetBundleEntry(int, bool)

Sets filter on PortBunde by PortBundleID and return entry. creates and executes SQL query on PortBundle table in configuration database

public PortBundleEntry GetBundleEntry(int portBundleId, bool forUpdate)

Parameters

portBundleId int

The EntryID.

forUpdate bool

Returns

PortBundleEntry

Remarks

This is a remote method.

GetCurrentUserID()

public int GetCurrentUserID()

Returns

int

GetCurrentUserName()

public string GetCurrentUserName()

Returns

string

GetCustomExistingEntry(TPortBundleEntry)

protected override PortBundleEntry GetCustomExistingEntry(TPortBundleEnum.TPortBundleEntry tEntry)

Parameters

tEntry TPortBundleEnum.TPortBundleEntry

Returns

PortBundleEntry

Remarks

Thread Safety: safe

GetNumberFormatProfileByID(string)

Retrieves a single NumberFormatProfileEntry from database.

public NumberProfilePrimaryCollection GetNumberFormatProfileByID(string ProfileID)

Parameters

ProfileID string

The ID of the profile

Returns

NumberProfilePrimaryCollection

Collection with one NumberFormatProfileEntry object.

GetPossibleIpPbxUserNames()

Returns all possible IpPbx User Names of the current user. Can be more than one if the current user is a windows user and multiple IppPbxUser are assigned to his windows account.

public SStringList GetPossibleIpPbxUserNames()

Returns

SStringList

StringList

GetProviderProfileByPortBundleType(PortBundleType)

Retrieves all ProviderProfiles matching the PortBundleType sorted by ProviderProfileName

public ProviderProfilePrimaryCollection GetProviderProfileByPortBundleType(PortBundleType PortBundleType)

Parameters

PortBundleType PortBundleType

The type of the Provider

Returns

ProviderProfilePrimaryCollection

GetProviderProfileByProviderID(string)

Retrieves a Provider Profile

public ProviderProfilePrimaryCollection GetProviderProfileByProviderID(string ProviderID)

Parameters

ProviderID string

The ID of the Provider as it is defined int the ProviderFile

Returns

ProviderProfilePrimaryCollection

GetProviderProfileInfos(PortBundleType?)

public List<ProviderProfileInfo> GetProviderProfileInfos(PortBundleType? portBundleType)

Parameters

portBundleType PortBundleType?

Returns

List<ProviderProfileInfo>

GetRoutedNumbersIDsByDescription(string)

Retrieves list of routing entry ids with a description starting with the given description

public SIntList GetRoutedNumbersIDsByDescription(string description)

Parameters

description string

Description filter.

Returns

SIntList

List of RoutedNumberIds

GetServerRequestTimeout(PortBundleEnumClient)

protected override TimeSpan GetServerRequestTimeout(PortBundleEnumClient client)

Parameters

client PortBundleEnumClient

Returns

TimeSpan

GetStaticPresharedKey(int)

Retrieves the current static PSK of the given Port(Trunk)

public string GetStaticPresharedKey(int PortID)

Parameters

PortID int

ID of the Port(Trunk)

Returns

string

PSK string will be empty id no static PSK is avaiable

GetSupportedClientVersions()

public SStringList GetSupportedClientVersions()

Returns

SStringList

HasRole(BuildInRoles)

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

ParseNumberFormatProfile(NumberProfileEntry)

Parses the XMLCode in the NumberProfileEntry.

public GenericNumberFormatProfile ParseNumberFormatProfile(NumberProfileEntry entry)

Parameters

entry NumberProfileEntry

The NumberProfileEntry to be parsed.

Returns

GenericNumberFormatProfile

GenereicNumberProfile or a derevied class.

ParseProviderProfile(ProviderProfileEntry)

Parses the XML Node of the ProviderProfile. To apply a profile to a PortBundleEntry use this method: setProviderProfile(ProviderProfileEntry)

public GenericProviderProfile ParseProviderProfile(ProviderProfileEntry entry)

Parameters

entry ProviderProfileEntry

Entry with XMLNode to be parsed.

Returns

GenericProviderProfile

A GenericProviderProfile containig the data from the XMPNode in database.

See Also

setProviderProfile(ProviderProfileEntry)

PingService(PortBundleEnumClient)

protected override void PingService(PortBundleEnumClient client)

Parameters

client PortBundleEnumClient

SetStaticPresharedKey(int, string)

Sets the static PSK of the given Port(Trunk)

public void SetStaticPresharedKey(int PortID, string PSK)

Parameters

PortID int

ID of the Port(Trunk)

PSK string

PSK of the Port(Trunk)

Remarks

This method will change data in database.

VerifyCanCreateVoiceChannels(int)

public void VerifyCanCreateVoiceChannels(int amount)

Parameters

amount int