Class FaxServerFacade

Namespace

SWConfigDataClientLib.Proxies.FaxServer

Assembly

IpPbxCDSClientLib.dll

Facade class for FaxServer

public class FaxServerFacade : FaxServerFacadeBase

Inheritance

object

SWCFProxy<FaxServerFacadeClient, IFaxServerFacade>

FaxServerFacadeBase

FaxServerFacade

Inherited Members

FaxServerFacadeBase.ClassTrace

Constructors

FaxServerFacade()

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

public FaxServerFacade()

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

AddFaxForwardingEntry(FaxForwardingEntryInfo)

Adds an fax forwarding entry.

public int AddFaxForwardingEntry(FaxForwardingEntryInfo entryInfo)

Parameters

entryInfo FaxForwardingEntryInfo

The fax forwarding entry information.

Returns

int

The added entry Id.

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: 0
Status: New

AddFaxJournalEntry(FaxJournalEntry)

Add FaxJournalEntry to FaxJournalTable table.

public void AddFaxJournalEntry(FaxJournalEntry entry)

Parameters

entry FaxJournalEntry

The new entry. The date attribute will be converted to UTC if nessesary

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

CreateClient(Binding, EndpointAddress)

protected override FaxServerFacadeClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

FaxServerFacadeClient

DeleteFaxForwardingEntry(int)

public void DeleteFaxForwardingEntry(int faxForwardingId)

Parameters

faxForwardingId int

DeleteFaxJob(int)

Delete specified Fax Job and all attachments

public void DeleteFaxJob(int JobID)

Parameters

JobID int

The ID of the Jax Job

DeleteFaxJobs(SIntList)

Deletes as set specified Fax Jobs and all attachments

public void DeleteFaxJobs(SIntList jobIDs)

Parameters

jobIDs SIntList

DeleteFaxJournalUpToDate(SDateTime)

Delete all entries from from table FaxJournalTable where Date field less or equal LimitDate.

public int DeleteFaxJournalUpToDate(SDateTime LimitDate)

Parameters

LimitDate SDateTime

The Limit Date.(can be local time)

Returns

int

Number of deleted entries.

DeleteFaxJournalUpToLimit(int)

Delete LimitNumber of entries from table FaxJournalTable (oldest by Date field)

public int DeleteFaxJournalUpToLimit(int Count)

Parameters

Count int

Number of entries to be deleted.

Returns

int

Number of deleted entries.

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

EnumFaxChannels()

Return list of all fax channels

public FaxChannelEntryCollection EnumFaxChannels()

Returns

FaxChannelEntryCollection

Collection of FaxChannelEntry

FormatDateTimeWithProductCulture(SDateTime, string)

public string FormatDateTimeWithProductCulture(SDateTime date, string format)

Parameters

date SDateTime

format string

Returns

string

FreeForReuse()

public override void FreeForReuse()

GetCurrentUserID()

public int GetCurrentUserID()

Returns

int

GetCurrentUserName()

public string GetCurrentUserName()

Returns

string

GetFaxChannelInfo(int)

Return one FaxChannelEntry.

public FaxChannelEntry GetFaxChannelInfo(int ChannelID)

Parameters

ChannelID int

JobID

Returns

FaxChannelEntry

FaxChannelEntry

GetFaxChannelStatus(int)

Return FaxChannelStatusEntry structure for given

public FaxChannelStatusEntry GetFaxChannelStatus(int ChannelID)

Parameters

ChannelID int

Returns

FaxChannelStatusEntry

FaxChannelStatus

GetFaxForwardingsByUserId(int)

Gets the fax forwardings configuration for the provided user Id.

public ICollection<FaxForwardingEntryInfo> GetFaxForwardingsByUserId(int userId)

Parameters

userId int

The user id.

Returns

ICollection<FaxForwardingEntryInfo>

GetFaxForwardingsForNumber(string, out int, out string, out string)

public FaxForwardingPrimaryCollection GetFaxForwardingsForNumber(string number, out int userID, out string userName, out string eMail)

Parameters

number string

userID int

userName string

eMail string

Returns

FaxForwardingPrimaryCollection

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

ID of the Job

Returns

FaxJobStatusEntry

FaxJobStatus

GetFaxJournalUpToDate(SDateTime)

Return an array of entries from table FaxJournalTable where Date field less or equal LimitDate.

public FaxJournalPrimaryCollection GetFaxJournalUpToDate(SDateTime LimitDate)

Parameters

LimitDate SDateTime

DateTime (can be local)

Returns

FaxJournalPrimaryCollection

Collection of FaxJournalEntries

GetFaxJournalUpToLimit(int)

Return an array of the n oldest entries from table FaxJournalTable.

public FaxJournalPrimaryCollection GetFaxJournalUpToLimit(int LimitCount)

Parameters

LimitCount int

Maximum number od returned entries

Returns

FaxJournalPrimaryCollection

Collection of FaxJournalEntries

GetFaxServerQueueView(int, int)

Return View with basic information required to Fax Server for handling jobs.

public FaxServerQueueViewPrimaryCollection GetFaxServerQueueView(int StatusMask, int PriorityMask)

Parameters

StatusMask int

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

PriorityMask int

1: Only Normal priority
2: Only High priority
3: Any proirity (3 is a bit mask of 1 and 2)

Returns

FaxServerQueueViewPrimaryCollection

GetFaxServerSettings()

Returns the FaxServerSettings

public FaxServerConfigEntry GetFaxServerSettings()

Returns

FaxServerConfigEntry

FaxServerSettings

Remarks

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

GetInternalFaxNumberOwnerID(string)

Returns the ID of the owner (user) of the given number. If the number does not exist or the number is no fax number the method will return 0.

public int GetInternalFaxNumberOwnerID(string szNumber)

Parameters

szNumber string

The given internal number

Returns

int

Returns the ID of the owning user. Oherwise 0.

GetLastJournalPrintTime()

Returns parameter LastJournalPrintTime from FaxServerSettings Table If LastJournalPrintTime is not set MinDate will be returned

public SDateTime GetLastJournalPrintTime()

Returns

SDateTime

Time of last printing

GetLoginID()

Returns a LoginID which can be used for SIP authentification for special clients.

public Guid GetLoginID()

Returns

Guid

GetNumberOfAvailableFaxChannels()

public CurrentAvailableCount GetNumberOfAvailableFaxChannels()

Returns

CurrentAvailableCount

GetNumberOfUserWithFaxNumbers()

Retrieves the number of users with configured fax number

public int GetNumberOfUserWithFaxNumbers()

Returns

int

number of users

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

GetPreSharedKey()

Returns the current pre shared key of this user for media encryption. The key is generated and will be changed if all phone devices of the user are logged off.

public string GetPreSharedKey()

Returns

string

String containing preshared key

Remarks

This method will use an addtional web service to provide a secure transport.

GetServerRequestTimeout(FaxServerFacadeClient)

protected override TimeSpan GetServerRequestTimeout(FaxServerFacadeClient client)

Parameters

client FaxServerFacadeClient

Returns

TimeSpan

GetSupportedClientVersions()

public SStringList GetSupportedClientVersions()

Returns

SStringList

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.

GetUserIdByUserName(string)

Returns the User Id for the given UserName

public int GetUserIdByUserName(string userName)

Parameters

userName string

Username

Returns

int

HasRole(BuildInRoles)

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

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

Attach to Job specified file

public void JobAttachFile(int JobID, int dwPosition, EFaxAttachementType eType, bool bCover, string strFileName, string strDescription, int 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 int

LockJob(int, bool)

Lock or unlock Fax job

public void LockJob(int JobID, bool bLock)

Parameters

JobID int

ID of the FaxJob

bLock bool

If bLock =TRUE and Job is already locked, an exception will be raised (can't lock the job which is already locked)
If bLock =FALSE, status will be changed to Unlocked in any case

Remarks

All lock operation will be synchronized.

PingService(FaxServerFacadeClient)

protected override void PingService(FaxServerFacadeClient client)

Parameters

client FaxServerFacadeClient

RegisterFaxServer(string, FaxServerInfo, FaxServerCallbackSubscription)

This function must be called by Fax Server on start up to register at CDSService. Registration required to let CDSService know where to redirect all clients calls, required Fax Server COM interface token must be used to in the StartWeService method of ICDSFacadeManager

public void RegisterFaxServer(string szHost, FaxServerInfo info, FaxServerCallbackSubscription callbackSubscription)

Parameters

szHost string

The name of the host the FaxServer is running on.

info FaxServerInfo

callbackSubscription FaxServerCallbackSubscription

SetFaxChannelStatus(int, FaxChannelStatusEntry)

CDSService updates the status of a channel

public void SetFaxChannelStatus(int ChannelID, FaxChannelStatusEntry entry)

Parameters

ChannelID int

ID of the channel

entry FaxChannelStatusEntry

The entry containing all new status values

Remarks

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

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)

SetFaxJobStatus(int, FaxJobStatusEntry)

CDSService updates Jobs entry in FaxJobs Table

public void SetFaxJobStatus(int JobID, FaxJobStatusEntry entry)

Parameters

JobID int

ID of the Job

entry FaxJobStatusEntry

The entry containing all new status values

Remarks

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

SetFaxServerSettings(FaxServerConfigEntry)

Saves the FaxServer settings

public void SetFaxServerSettings(FaxServerConfigEntry entry)

Parameters

entry FaxServerConfigEntry

The Fax Server Settings

SetLastJournalPrintTime(SDateTime)

Updates last journal print time in Fax Server general settings

public void SetLastJournalPrintTime(SDateTime LastPrintTime)

Parameters

LastPrintTime SDateTime

Time of last printing

UnlockAllJobs()

Unlocks all locked jobs.

public int UnlockAllJobs()

Returns

int

Number of unlocked jobs.

Remarks

All lock operation will be synchronized.

UnregisterFaxServer(string)

public bool UnregisterFaxServer(string szHost)

Parameters

szHost string

Returns

bool