Class FaxAdminFacade

Namespace

SWConfigDataClientLib.Proxies.FaxAdmin

Assembly

IpPbxCDSClientLib.dll

Facade class for FaxAdmin

public class FaxAdminFacade : FaxAdminFacadeBase

Inheritance

object

SWCFProxy<FaxAdminFacadeClient, IFaxAdminFacade>

FaxAdminFacadeBase

FaxAdminFacade

Inherited Members

FaxAdminFacadeBase.ClassTrace

Constructors

FaxAdminFacade()

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

public FaxAdminFacade()

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

AddFaxChannel(FaxChannelEntry)

Adds a new FaxChannel

public int AddFaxChannel(FaxChannelEntry entry)

Parameters

entry FaxChannelEntry

The FaxChannelInfo class with the new values

Returns

int

ChannelID

CheckFeatureList(int, FeatureList)

Checks the Features for the given user. All features in the given list will be checked the flags Enabled and Licensed will be set.

public void CheckFeatureList(int UserID, FeatureList featureList)

Parameters

UserID int

The UserID of the User. The UserID will be used to retrieve the Enabled information. Set UserID to 0 to retrieve license information only

featureList FeatureList

The list of feature to be checked

CheckVersion()

public void CheckVersion()

ControlFaxChannel(int, EFaxChannelControlAction, string)

Force an action dwAction for specified dwFaxChannelId.

public void ControlFaxChannel(int ChannelID, EFaxChannelControlAction Action, string Reason)

Parameters

ChannelID int

The ID of the Channel

Action EFaxChannelControlAction

Supported Action

Reason string

user friendly reason

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 FaxAdminFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

FaxAdminFacadeClient

DeleteFaxChannel(int)

Deletes a FaxChannel

public void DeleteFaxChannel(int ChannelID)

Parameters

ChannelID int

The ID of the channel to be deleted.

DeleteFile(string, PreDefinedFileCategory)

Deletes a file

public void DeleteFile(string strFileName, PreDefinedFileCategory category)

Parameters

strFileName string

category PreDefinedFileCategory

DownloadFile(string, PreDefinedFileCategory)

Downloads a file

public string DownloadFile(string strFileName, PreDefinedFileCategory category)

Parameters

strFileName string

category PreDefinedFileCategory

Returns

string

Filename in local file cache.

EnumCoverGraphics()

Returns all available Cover Graphic file names

public SStringList EnumCoverGraphics()

Returns

SStringList

List of avaiable cover graphics

EnumCoverPages()

Returns all available Cover Page file names

public SStringList EnumCoverPages()

Returns

SStringList

List of avaiable cover pages

EnumFaxChannels()

Return list of all fax channels

public FaxChannelEntryCollection EnumFaxChannels()

Returns

FaxChannelEntryCollection

Collection of FaxChannelEntry

EnumFaxPrinters()

Return list of all fax printers

public FaxPrinterEntryCollection EnumFaxPrinters()

Returns

FaxPrinterEntryCollection

Collection of FaxPrinterEntry

FreeForReuse()

public override void FreeForReuse()

GetAvailableLicenses()

public int GetAvailableLicenses()

Returns

int

GetCurrentUserID()

public int GetCurrentUserID()

Returns

int

GetCurrentUserName()

public string GetCurrentUserName()

Returns

string

GetFaxAdminJobQueueView(uint, uint, bool)

Returns view with basic information visible in Fax Administration "Fax documents on server"

public FaxAdminJobQueueViewPrimaryCollection GetFaxAdminJobQueueView(uint dwStatusMask, uint dwMaxNumberOfItems, bool bStartFormFirstJob)

Parameters

dwStatusMask uint

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

dwMaxNumberOfItems uint

dwMaxNumberOfItems parameter specify how much faxes we need (0=unlimited.

bStartFormFirstJob bool

If bStartFromFirstJob is ture, faxes will be sorted in oldest-first order.

Returns

FaxAdminJobQueueViewPrimaryCollection

FaxChannelEntry

GetFaxChannelInfo(int)

Return one FaxChannelEntry.

public FaxChannelEntry GetFaxChannelInfo(int ChannelID)

Parameters

ChannelID int

JobID

Returns

FaxChannelEntry

FaxChannelEntry

GetFaxFilesInfo(out int, out long, out long)

public void GetFaxFilesInfo(out int nJobCount, out long nFaxJobAttachmentsSize, out long nTotalFaxFilesSize)

Parameters

nJobCount int

nFaxJobAttachmentsSize long

nTotalFaxFilesSize long

GetFaxFilesInfo(out int, out long, out long, out bool, out long)

public SDriveType GetFaxFilesInfo(out int nJobCount, out long nFaxJobAttachmentsSize, out long nTotalFaxFilesSize, out bool bFilesLocatedInFileSystem, out long lAvailableSpaceinFS)

Parameters

nJobCount int

nFaxJobAttachmentsSize long

nTotalFaxFilesSize long

bFilesLocatedInFileSystem bool

lAvailableSpaceinFS long

Returns

SDriveType

GetFaxFwdTableView()

Return View with forwarding table summary

public FaxFwdTableViewPrimaryCollection GetFaxFwdTableView()

Returns

FaxFwdTableViewPrimaryCollection

List of all internal-, public number, forwarding combinations

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)

Return FaxJobStatus structure for given JobId

public FaxJobStatusEntry GetFaxJobStatus(int JobID)

Parameters

JobID int

Returns

FaxJobStatusEntry

FaxJobStatus

GetFaxServerSettings()

Returns the FaxServer settings

public FaxServerConfigEntry GetFaxServerSettings()

Returns

FaxServerConfigEntry

FaxServerConfigEntry

Remarks

The returned FaxServerConfigEntry contains FaxChannel and FaxPrinter Collections. This Collection will be allways empty.

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()

Return Fax Server basic information

public FaxServerInfo GetServerInfo()

Returns

FaxServerInfo

FaxServerInfo

GetServerRequestTimeout(FaxAdminFacadeClient)

protected override TimeSpan GetServerRequestTimeout(FaxAdminFacadeClient client)

Parameters

client FaxAdminFacadeClient

Returns

TimeSpan

GetServerStatusString()

Return Fax Server current status in string format

public string GetServerStatusString()

Returns

string

Status string

GetSupportedClientVersions()

public SStringList GetSupportedClientVersions()

Returns

SStringList

GetTotalLicenses()

public int GetTotalLicenses()

Returns

int

GetTotalLicenses(out uint, out uint, out int)

Returns some Fax lincense infos.

public void GetTotalLicenses(out uint EffectiveTotalFaxUsers, out uint EffectiveTotalFaxChannels, out int hr)

Parameters

EffectiveTotalFaxUsers uint

EffectiveTotalFaxChannels uint

hr int

COM Result in RCW.

HasRole(BuildInRoles)

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

NotifyFaxServerSettings(int)

Notifies the FaxServer to reload fax server settings.

public void NotifyFaxServerSettings(int iFaxServerID)

Parameters

iFaxServerID int

Id of the faxServer can be 0

PingService(FaxAdminFacadeClient)

protected override void PingService(FaxAdminFacadeClient client)

Parameters

client FaxAdminFacadeClient

SetFaxChannelInfo(int, FaxChannelEntry)

Set the FaxChannelInfo of an exisiting Channel

public void SetFaxChannelInfo(int ChannelID, FaxChannelEntry entry)

Parameters

ChannelID int

JobID

entry FaxChannelEntry

The FaxChannelInfo class with the new values

SetFaxServerSettings(FaxServerConfigEntry)

Saves the FaxServer settings

public void SetFaxServerSettings(FaxServerConfigEntry entry)

Parameters

entry FaxServerConfigEntry

The Fax Server Settings

UploadFile(string, PreDefinedFileCategory)

Uploads a file

public void UploadFile(string localFileName, PreDefinedFileCategory category)

Parameters

localFileName string

category PreDefinedFileCategory