Class FaxPrinterGatewayFacade

Namespace

SWConfigDataClientLib.Proxies.FaxPrinterGateway

Assembly

IpPbxCDSClientLib.dll

Facade class for FaxPrinterGateway

public class FaxPrinterGatewayFacade : FaxPrinterGatewayFacadeBase

Inheritance

object

SWCFProxy<FaxPrinterGatewayFacadeClient, IFaxPrinterGatewayFacade>

FaxPrinterGatewayFacadeBase

FaxPrinterGatewayFacade

Inherited Members

FaxPrinterGatewayFacadeBase.ClassTrace

Constructors

FaxPrinterGatewayFacade()

Create instance of FaxPrinterGatewayFacade. Ony used by Unmanaged Wrapper. To create an instance of this class use the LibManager.

public FaxPrinterGatewayFacade()

Remarks

The connection will be established by the first remote call.

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

CheckVersion()

public void CheckVersion()

ControlFaxJob(int, EFaxJobControlAction, string)

public void ControlFaxJob(int JobID, EFaxJobControlAction Action, string Reason)

Parameters

JobID int

Action EFaxJobControlAction

Reason string

CreateClient(Binding, EndpointAddress)

protected override FaxPrinterGatewayFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

FaxPrinterGatewayFacadeClient

EnumAttachments(int)

Return list of all attachments for specified Job. All files will be download into local file cache if nessesary

public FaxJobAttachmentList EnumAttachments(int JobID)

Parameters

JobID int

JobID

Returns

FaxJobAttachmentList

List of FaxJobAttachments

FreeForReuse()

public override void FreeForReuse()

GetCurrentUserID()

public int GetCurrentUserID()

Returns

int

GetCurrentUserName()

public string GetCurrentUserName()

Returns

string

GetFaxJobInfo(int)

Return FaxJobEntry(Info) structure for given JobId

public FaxJobEntry GetFaxJobInfo(int JobID)

Parameters

JobID int

ID of the Job

Returns

FaxJobEntry

FaxJobEntry

GetFaxJobStatus(int)

public FaxJobStatusEntry GetFaxJobStatus(int JobID)

Parameters

JobID int

Returns

FaxJobStatusEntry

GetFaxPrinterGatewayView(string, int)

View and function to receive all jobs which must be printed:

public FaxPrinterGatewayViewPrimaryCollection GetFaxPrinterGatewayView(string strGatewayName, int dwStatusMask)

Parameters

strGatewayName string

Name of the FaxPrinterGateway

dwStatusMask int

This View will return summary information about all Jobs available for printing with "Status" field matching dwStatusMask. If dwStatusMask ist 0 all new Jobs will be returned.

Returns

FaxPrinterGatewayViewPrimaryCollection

Collection of FaxJobs

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

GetServerInfo()

public FaxServerInfo GetServerInfo()

Returns

FaxServerInfo

GetServerRequestTimeout(FaxPrinterGatewayFacadeClient)

protected override TimeSpan GetServerRequestTimeout(FaxPrinterGatewayFacadeClient client)

Parameters

client FaxPrinterGatewayFacadeClient

Returns

TimeSpan

GetSupportedClientVersions()

public SStringList GetSupportedClientVersions()

Returns

SStringList

HasRole(BuildInRoles)

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

PingService(FaxPrinterGatewayFacadeClient)

protected override void PingService(FaxPrinterGatewayFacadeClient client)

Parameters

client FaxPrinterGatewayFacadeClient

ReportAvailablePrinters(string, SStringList)

This function is called by Fax Printer Gateway to report all available printers (list of printer names) names visible from Fax Printer Gateway

public void ReportAvailablePrinters(string strGatewayName, SStringList aStrNames)

Parameters

strGatewayName string

aStrNames SStringList

List of available printers