Class FaxClientFacade

Namespace

SWConfigDataClientLib.Proxies.FaxClient

Assembly

IpPbxCDSClientLib.dll

Facade class for IppbxServer

public class FaxClientFacade : FaxClientFacadeBase

Inheritance

object

SWCFProxy<FaxClientFacadeClient, IFaxClientFacade>

FaxClientFacadeBase

FaxClientFacade

Inherited Members

FaxClientFacadeBase.ClassTrace

Constructors

FaxClientFacade()

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

public FaxClientFacade()

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

AddFaxJob(string)

Creates a new empty Job.

public int AddFaxJob(string szJobType)

Parameters

szJobType string

FaxType

Returns

int

Return new Job id.

Remarks

Defaults:
OwnerType: User
OwnerID: CurrentUserID
Status: New

CheckStandbyStatus(out bool, out string, out string)

Reads and checks the standby configuration of the IpPbxServer. If this methods fails on any reason the client should swtich to other server.

public StandbyServerType CheckStandbyStatus(out bool bIsActive, out string strMaster, out string strStandby)

Parameters

bIsActive bool

The server is active or not

strMaster string

The master server (not supported in this version)

strStandby string

The standby server (not supported in this versio)

Returns

StandbyServerType

CheckVersion()

public void CheckVersion()

ControlFaxJob(int, EFaxJobControlAction, string)

Change status (dwAction) for specified Job (dwJobId). Optionally user-friendly reason (strReason) could be provided

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

Parameters

JobID int

ID of the Job

Action EFaxJobControlAction

Action

Reason string

user-friendly reason

CreateClient(Binding, EndpointAddress)

protected override FaxClientFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

FaxClientFacadeClient

DownloadFile(string, PreDefinedFileCategory)

DownloadsFile a file

public string DownloadFile(string strFilename, PreDefinedFileCategory FileCategory)

Parameters

strFilename string

Filename

FileCategory PreDefinedFileCategory

FileCategory

Returns

string

Filepath in local file cache

Remarks

Files in Scope User or UserDefault will not be found.

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

EnumFaxNumbers()

Return list of internal fax numbers of this user

public SStringList EnumFaxNumbers()

Returns

SStringList

Array of numbers

EnumFaxPrinters()

Return list of all fax printers

public FaxPrinterEntryCollection EnumFaxPrinters()

Returns

FaxPrinterEntryCollection

Collection of FaxPrinterEntry

EnumLetterHeads()

Return a list of all fax letterheads file names without extension (All files with category "Fax Letterhead")

public SStringList EnumLetterHeads()

Returns

SStringList

List of avaiable letter heads

FreeForReuse()

public override void FreeForReuse()

GetCurrentUserID()

public int GetCurrentUserID()

Returns

int

GetCurrentUserIDFromJobEnum()

Retrieves the UserID of the current user.

public int GetCurrentUserIDFromJobEnum()

Returns

int

GetCurrentUserName()

public string GetCurrentUserName()

Returns

string

GetFaxClientArchiveView(int)

Return View with basic information about faxes required for fax archiving

public FaxClientArchiveViewPrimaryCollection GetFaxClientArchiveView(int StatusMask)

Parameters

StatusMask int

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

Returns

FaxClientArchiveViewPrimaryCollection

Collection of JaxJobs

GetFaxClientInboxView(int)

Return View with basic information visible in Fax Client "Inbox" folder

public FaxClientInboxViewPrimaryCollection GetFaxClientInboxView(int StatusMask)

Parameters

StatusMask int

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

Returns

FaxClientInboxViewPrimaryCollection

Collection of JaxJobs

GetFaxClientOutboxView(int)

Return View with basic information visible in Fax Client "Sent", "Error" and "Outbox" folders

public FaxClientOutboxViewPrimaryCollection GetFaxClientOutboxView(int StatusMask)

Parameters

StatusMask int

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

Returns

FaxClientOutboxViewPrimaryCollection

Collection of JaxJobs

GetFaxJobInfo(int)

Return FaxJobEntry(Info) structure for given JobId

public FaxJobEntry GetFaxJobInfo(int JobID)

Parameters

JobID int

ID of the Job

Returns

FaxJobEntry

FaxJobEntry

GetLocalSettings()

Gets the local fax settings for the current user. An empty setting entry will be returned

public FaxClientLocalConfigEntry GetLocalSettings()

Returns

FaxClientLocalConfigEntry

Local settting class.

GetLocalSettings(int)

Gets the local fax settings for an user. An empty setting entry will be returned

public FaxClientLocalConfigEntry GetLocalSettings(int UserID)

Parameters

UserID int

The ID of the user. Set to 0 for the addressing the current user.

Returns

FaxClientLocalConfigEntry

Local settings class.

Remarks

If the UserID is not from the current user the API Role UserAdminRO is required.

GetNumberOfAvailableFaxChannels()

public CurrentAvailableCount GetNumberOfAvailableFaxChannels()

Returns

CurrentAvailableCount

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

GetServerCoverPageFile(out string)

Get the configured cover page file on the server.

public void GetServerCoverPageFile(out string sCoverPageFile)

Parameters

sCoverPageFile string

FileName, empty if no cover page is configured

GetServerInfo()

public FaxServerInfo GetServerInfo()

Returns

FaxServerInfo

GetServerRequestTimeout(FaxClientFacadeClient)

protected override TimeSpan GetServerRequestTimeout(FaxClientFacadeClient client)

Parameters

client FaxClientFacadeClient

Returns

TimeSpan

GetServerTransmitReportingRestrictions(out bool, out bool, out bool)

Return server transmit reporting restrictions

public void GetServerTransmitReportingRestrictions(out bool rAllowKeepInErrorFaxesFolder, out bool rAllowKeepInSentFaxesFolder, out bool rAllowAttachEntireFax)

Parameters

rAllowKeepInErrorFaxesFolder bool

rAllowKeepInSentFaxesFolder bool

rAllowAttachEntireFax bool

GetSupportedClientVersions()

public SStringList GetSupportedClientVersions()

Returns

SStringList

HasRole(BuildInRoles)

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

JobAttachFile(int, int, EFaxAttachementType, bool, string, string, uint)

Attach to Job specified file

public void JobAttachFile(int JobID, int dwPosition, EFaxAttachementType eType, bool bCover, string strFileName, string strDescription, uint dwPages)

Parameters

JobID int

ID of the Job

dwPosition int

If position is less than 0, file will be placed to the end, otherwise to specified position

eType EFaxAttachementType

Attachment Type

bCover bool

Is cover page

strFileName string

Name of the file to be added

strDescription string

Descrioption

dwPages uint

PingService(FaxClientFacadeClient)

protected override void PingService(FaxClientFacadeClient client)

Parameters

client FaxClientFacadeClient

SetFaxJobInfo(int, FaxJobEntry)

CDSService updates Jobs entry in FaxJobs Table

public void SetFaxJobInfo(int JobID, FaxJobEntry entry)

Parameters

JobID int

ID of the Job

entry FaxJobEntry

The entry containing all new values

Remarks

This method does not detect concurrency vioalations. (Nevertheless concurrency violation exception can be thrown)

SetJobTransmitReportingParams(int, bool, bool, bool, EFaxJobConfirmationMode, EFaxJobConfirmationToEmailAttachmentFormat, bool, EFaxJobConfirmationMode, string, bool, EFaxJobConfirmationMode, EFaxJobConfirmationToEmailAttachmentFormat, bool, EFaxJobConfirmationMode, string)

Update Jobs transmit reporting parameters

public void SetJobTransmitReportingParams(int dwJobId, bool bKeepSent, bool bKeepFailed, bool bSucceedConfirmationToEmailEnabled, EFaxJobConfirmationMode eSucceedConfirmationToEmailMode, EFaxJobConfirmationToEmailAttachmentFormat eSucceedConfirmationToEmailAttachmentFormat, bool bSucceedConfirmationToPrinterEnabled, EFaxJobConfirmationMode eSucceedConfirmationToPrinterMode, string strSucceedConfirmationPrinterName, bool bFailedNotificationToEmailEnabled, EFaxJobConfirmationMode eFailedNotificationToEmailMode, EFaxJobConfirmationToEmailAttachmentFormat eFailedNotificationToEmailAttachmentFormat, bool bFailedNotificationToPrinterEnabled, EFaxJobConfirmationMode eFailedNotificationToPrinterMode, string strFailedNotificationPrinterName)

Parameters

dwJobId int

bKeepSent bool

bKeepFailed bool

bSucceedConfirmationToEmailEnabled bool

eSucceedConfirmationToEmailMode EFaxJobConfirmationMode

eSucceedConfirmationToEmailAttachmentFormat EFaxJobConfirmationToEmailAttachmentFormat

bSucceedConfirmationToPrinterEnabled bool

eSucceedConfirmationToPrinterMode EFaxJobConfirmationMode

strSucceedConfirmationPrinterName string

bFailedNotificationToEmailEnabled bool

eFailedNotificationToEmailMode EFaxJobConfirmationMode

eFailedNotificationToEmailAttachmentFormat EFaxJobConfirmationToEmailAttachmentFormat

bFailedNotificationToPrinterEnabled bool

eFailedNotificationToPrinterMode EFaxJobConfirmationMode

strFailedNotificationPrinterName string

SetLocalSettings(FaxClientLocalConfigEntry)

Sets the fax client settings of this user. There is no concurrency check.

public void SetLocalSettings(FaxClientLocalConfigEntry entry)

Parameters

entry FaxClientLocalConfigEntry

The settings entry

SetLocalSettings(int, FaxClientLocalConfigEntry)

Sets the fax client settings of an user. There is no concurrency check.

public void SetLocalSettings(int UserID, FaxClientLocalConfigEntry entry)

Parameters

UserID int

The ID of the user. Set to 0 for the addressing the current user.

entry FaxClientLocalConfigEntry

The settings entry

Remarks

If the UserID is not from the current user the API Role UserAdminRO is required.

TryGetLocalSettings(int, out FaxClientLocalConfigEntry)

Gets the local fax settings for an user. An empty setting entry will be returned

public bool TryGetLocalSettings(int UserID, out FaxClientLocalConfigEntry entry)

Parameters

UserID int

The ID of the user. Set to 0 for the addressing the current user.

entry FaxClientLocalConfigEntry

Returns

bool

Local settings class.

Remarks

If the UserID is not from the current user the API Role UserAdminRO is required.