Class PortManagerFacade

Namespace

SWConfigDataClientLib.Proxies.PortManager

Assembly

IpPbxCDSClientLib.dll

Facade class for PortManager like Gateway and LinkManager. The PortManagerFacade contains a trunk view including all relevant sub configuration items.

public class PortManagerFacade : PortManagerFacadeBase

Inheritance

object

SWCFProxy<PortManagerFacadeClient, IPortManagerFacade>

PortManagerFacadeBase

PortManagerFacade

Inherited Members

PortManagerFacadeBase.ClassTrace

Constructors

PortManagerFacade()

Creates instance of PortManagerFacade. (For use by Unmanaged Wrapper only)

public PortManagerFacade()

Remarks

Use the LibManager to create an instance of this class.

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

AddPortWithPortID(PortPrimaryCollection, int)

Adds or replaces a Port with a given PortID from database

public PortEntry AddPortWithPortID(PortPrimaryCollection collection, int PortID)

Parameters

collection PortPrimaryCollection

PortID int

Returns

PortEntry

CheckVersion()

public void CheckVersion()

CreateClient(Binding, EndpointAddress)

protected override PortManagerFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

PortManagerFacadeClient

Dispose()

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

public void Dispose()

FreeForReuse()

public override void FreeForReuse()

GetAllProviderProfiles()

Retrieves all Provider Profiles

public ProviderProfilePrimaryCollection GetAllProviderProfiles()

Returns

ProviderProfilePrimaryCollection

GetCurrentUserID()

public int GetCurrentUserID()

Returns

int

GetCurrentUserName()

public string GetCurrentUserName()

Returns

string

GetPortCollection(PortBundleType, string)

Retrieves a collection of PortEntries. The collection can not be used to write configuration items to database.

public PortPrimaryCollection GetPortCollection(PortBundleType portBundleType, string host)

Parameters

portBundleType PortBundleType

The type of ports.

host string

The host of the port manager.

Returns

PortPrimaryCollection

Collection of PortEntries. Collection can be empty but not null.

Examples

PortManagerFacade portManagerFacade = m_LibManager.GetPortManagerFacade();

PortPrimaryCollection portCollection = portManagerFacade.GetPortCollection(PortBundleType.SIP_GW | PortBundleType.SIP, "Athen");
foreach (PortEntry portEntry in portCollection)
{
    System.Console.WriteLine("Trunk:\t" + portEntry.Name);
       System.Console.WriteLine("\t" + portEntry.Description);
       System.Console.WriteLine("\t" + portEntry.NonMatchingNumberCallingNumber);
}
portManagerFacade.FreeForReuse();

GetPortLoginID(int)

Get a LoginID to register the Trunk at the IpPbxServer. The id is only usable for one registration. For a new registration a new ID have to be requested.

public Guid GetPortLoginID(int iPortID)

Parameters

iPortID int

Id of the trunk(Port).

Returns

Guid

LoginID (Gudi)

GetPortParameterIntValue(int, string)

public int GetPortParameterIntValue(int iPortID, string strParamteterName)

Parameters

iPortID int

strParamteterName string

Returns

int

GetPortParameterStringValue(int, string)

public string GetPortParameterStringValue(int iPortID, string strParamteterName)

Parameters

iPortID int

strParamteterName string

Returns

string

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

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

GetServerRequestTimeout(PortManagerFacadeClient)

protected override TimeSpan GetServerRequestTimeout(PortManagerFacadeClient client)

Parameters

client PortManagerFacadeClient

Returns

TimeSpan

GetSupportedClientVersions()

public SStringList GetSupportedClientVersions()

Returns

SStringList

HasRole(BuildInRoles)

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

PingService(PortManagerFacadeClient)

protected override void PingService(PortManagerFacadeClient client)

Parameters

client PortManagerFacadeClient

PortParameterDelete(int, string)

public void PortParameterDelete(int iPortID, string strParamteterName)

Parameters

iPortID int

strParamteterName string

PortParameterExists(int, string)

public bool PortParameterExists(int iPortID, string strParamteterName)

Parameters

iPortID int

strParamteterName string

Returns

bool

SetPortParameterIntValue(int, string, int)

public void SetPortParameterIntValue(int iPortID, string strParamteterName, int iValue)

Parameters

iPortID int

strParamteterName string

iValue int

SetPortParameterIntValue(int, string, int, int)

public void SetPortParameterIntValue(int iPortID, string strParamteterName, int iValue, int iDefaultValue)

Parameters

iPortID int

strParamteterName string

iValue int

iDefaultValue int

SetPortParameterStringValue(int, string, string)

public void SetPortParameterStringValue(int iPortID, string strParamteterName, string strValue)

Parameters

iPortID int

strParamteterName string

strValue string

SetPortParameterStringValue(int, string, string, string)

public void SetPortParameterStringValue(int iPortID, string strParamteterName, string strValue, string strDefaultValue)

Parameters

iPortID int

strParamteterName string

strValue string

strDefaultValue string

WriteBoardConfiguation(string, GatewayBoardConfig)

public void WriteBoardConfiguation(string GatewayHostName, GatewayBoardConfig BoardConfig)

Parameters

GatewayHostName string

BoardConfig GatewayBoardConfig