Symbian
Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]

 » Developer Library » API Reference » C++ API reference » Fax Client MTM » CFaxMtmClient

Location: FAXC.h
Link against: fxcm.lib

Class CFaxMtmClient

class CFaxMtmClient

Support

Supported from 6.0

Description

Fax client MTM interface.

Most of the functions in this class are implementations of the virtual functions defined by the base class CBaseMtm.

Derivation

CBaseBase class for all classes to be instantiated on the heap
CBaseMtmProvides a high-level interface for accessing and manipulating a Message Server entry
CFaxMtmClientFax client MTM interface
MMsvEntryObserverProvides the interface for notification of events associated with an entry

Defined in CFaxMtmClient:
AddAddresseeL(), AddAddresseeL(), AddresseeTextLC(), CFaxMtmClient(), ConstructL(), ContextEntrySwitched(), DoAddAddressee(), FaxHeader(), FaxHeader(), FaxSettings(), FaxSettings(), Find(), FindInBodyL(), FindInFaxL(), FindInRecipientsL(), ForwardL(), GetDefaultResolutionL(), InvokeAsyncFunctionL(), InvokeSyncFunctionL(), LoadMessageL(), NewL(), QueryCapability(), RemoveAddressee(), ReplyL(), ResetData(), SaveMessageL(), SetupAddresseeListL(), ValidNumber(), ValidRecipients(), ValidateMessage(), iFaxHeader, iFaxSettings, iFs, iSession, ~CFaxMtmClient()

Inherited from CBase:
operator new()

Inherited from CBaseMtm:
AddresseeList(), BioTypeChangedL(), Body(), CreateAttachmentL(), CreateMessageL(), DeleteAttachmentL(), Entry(), HandleEntryEventL(), HasContext(), RestoreBodyL(), RestoreL(), Session(), SetCurrentEntryL(), SetSubjectL(), StoreBodyL(), StoreL(), SubjectL(), SwitchCurrentEntryL(), Type(), iAddresseeList, iCharFormatLayer, iMsvEntry, iParaFormatLayer

Inherited from MMsvEntryObserver:
EMsvChildrenChanged, EMsvChildrenInvalid, EMsvChildrenMissing, EMsvContextInvalid, EMsvDeletedChildren, EMsvEntryChanged, EMsvEntryDeleted, EMsvEntryMoved, EMsvNewChildren, EMsvStoreCommitted, EMsvStoreCreated, EMsvStoreDeleted, HandleEntryEvent(), TMsvEntryEvent

Construction and destruction

~CFaxMtmClient()

~CFaxMtmClient();

Description

Destructor.

[Top]

Member functions

SaveMessageL()

void SaveMessageL();

Description

Commits cached changes to the current message context to the storage controlled by the Message Server.

Leave codes

Standard store-related errors.

LoadMessageL()

void LoadMessageL();

Description

Loads the cache with the message data for the current context.

Leave codes

Standard store-related errors.

ReplyL()

CMsvOperation* ReplyL(TMsvId aId, TMsvPartList aPartList, TRequestStatus& aCompletionStatus);

Description

Unsupported for fax.

Parameters

TMsvId aId

Unused.
TMsvPartList aPartList

Unused.
TRequestStatus& aCompletionStatus

Unused.

Return value

CMsvOperation *

Unused.

ForwardL()

CMsvOperation* ForwardL(TMsvId aId, TMsvPartList aPartList, TRequestStatus& aCompletionStatus);

Description

Creates a fax forwarded message from the current message context.

Parameters

TMsvId aDestination

The entry to which to assign the forwarded message

TMsvPartList aPartList

Defines the parts that are to be copied from the original message into the forwarded message

TRequestStatus& aCompletionStatus

The request status to be completed when the operation has finished

Return value

CMsvOperation*

If successful, this is an asynchronously completing forward message operation. If failed, this is a completed operation, with status set to the relevant error code.

ValidateMessage()

TMsvPartList ValidateMessage(TMsvPartList aPartList);

Description

Validates the current message context.

The addresses for the message are checked to be well-formed addresses.

Parameters

TMsvPartList aPartList

Indicates the message parts for which validation is requested

Return value

TMsvPartList

If valid, KErrNone If invalid, identifies the invalid part(s). The error value is the bitmask of the TMsvPartList IDs for each invalid part

Find()

TMsvPartList Find(const TDesC& aTextToFind, TMsvPartList aPartList);

Description

Searches the specified message part(s) for the plain-text version of the text to be found.

Parameters

const TDesC& aTextToFind

The plain-text version of the text to be found.

TMsvPartList aPartList

Indicates the message parts which should be searched.

Return value

TMsvPartList

If the text was not found, or searching is unsupported, 0. If the text was found, a bitmask of the TMsvPartList IDs for each part in which the text was present.

AddAddresseeL()

void AddAddresseeL(const TDesC& aRealAddress);

Description

Adds an addressee for the current context.

Parameters

const TDesC& aRealAddress

String representing an address to be added to the list for the current message

AddAddresseeL()

void AddAddresseeL(const TDesC& aRealAddress, const TDesC& aAlias);

Description

Adds an addressee with an alias for the current context.

Parameters

const TDesC& aRealAddress

String representing an address to be added to the list for the current message

const TDesC& aAlias

Alias information

RemoveAddressee()

void RemoveAddressee(TInt aIndex);

Description

Removes an address from the current address list.

Parameters

TInt aIndex

Index of address to be removed

QueryCapability()

TInt QueryCapability(TUid aCapability, TInt& aResponse);

Description

Queries if the MTM supports a particular capability, specified by a UID.

Parameters

TUid aCapability

UID of capability to be queried

TInt& aResponse

Response value. The format of the response varies according to the capability.

Return value

TInt

KErrNone: aCapability is a recognised value and a response is returned KErrNotSupported: aCapability is not a recognised value

InvokeSyncFunctionL()

void InvokeSyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection, TDes8& aParameter);

Description

Unused for fax.

Parameters

TInt aFunctionId

Unused.
const CMsvEntrySelection& aSelection

Unused.
TDes8& aParameter

Unused.

InvokeAsyncFunctionL()

CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection, TDes8& aParameter, TRequestStatus& aCompletionStatus);

Description

Invokes asynchronous fax-specific operations.

Parameters

TInt aFunctionId

Specifies which operation to perform. The specific operations are defined by the TFaxCmds enumeration.

const CMsvEntrySelection& aSelection

A selection of messages, the use of which is specific to the selected operation
TDes8& aParameter

Packaged object, the use of which is specific to the selected operation
TRequestStatus& aCompletionStatus

The status when the operation completes.

Return value

CMsvOperation*

If successful, this is an asynchronously completing operation. If failed, this is a completed operation, with status set to the relevant error code.

See also:

FaxHeader()

inline CFaxHeader& FaxHeader();

Description

Gets the fax header for the current context: this holds recipient information.

Return value

CFaxHeader &

The fax header for the current context

FaxHeader()

inline const CFaxHeader& FaxHeader() const;

Description

Gets the (const) fax header for the current context: this holds recipient information.

Return value

const CFaxHeader &

The fax header for the current context

FaxSettings()

inline TMTMFaxSettings& FaxSettings();

Description

Gets the current fax service settings.

Return value

TMTMFaxSettings &

The current fax service settings

FaxSettings()

inline const TMTMFaxSettings& FaxSettings() const;

Description

Gets the (const) current fax service settings.

Return value

const TMTMFaxSettings &

The current fax service settings

[Top]

Internal members

Description

This member is internal and not intended for use.

NewL()

static CFaxMtmClient* NewL(CRegisteredMtmDll& aRegisteredMtmDll, CMsvSession& aMsvSession);

Description

This member is internal and not intended for use.

CFaxMtmClient()

protected: CFaxMtmClient(CRegisteredMtmDll& aRegisteredMtmDll, CMsvSession& aMsvSession);

Description

This member is internal and not intended for use.

ConstructL()

protected: void ConstructL();

Description

This member is internal and not intended for use.

iFaxHeader

private: CFaxHeader* iFaxHeader;

Description

This member is internal and not intended for use.

iFaxSettings

private: TMTMFaxSettings iFaxSettings;

Description

This member is internal and not intended for use.

iFs

private: RFs iFs;

Description

This member is internal and not intended for use.

iSession

private: CMsvSession& iSession;

Description

This member is internal and not intended for use.

ContextEntrySwitched()

protected: void ContextEntrySwitched();

Description

This member is internal and not intended for use.

DoAddAddressee()

private: TInt DoAddAddressee(const TDesC& aText);

Description

This member is internal and not intended for use.

AddresseeTextLC()

private: HBufC* AddresseeTextLC(const TDesC& aRealAddress, const TDesC& aAlias);

Description

This member is internal and not intended for use.

SetupAddresseeListL()

private: void SetupAddresseeListL();

Description

This member is internal and not intended for use.

ValidNumber()

private: TBool ValidNumber(const TDesC8& aNumber);

Description

This member is internal and not intended for use.

ValidRecipients()

private: TMsvPartList ValidRecipients();

Description

This member is internal and not intended for use.

ResetData()

private: void ResetData();

Description

This member is internal and not intended for use.

GetDefaultResolutionL()

private: TFaxResolution GetDefaultResolutionL();

Description

This member is internal and not intended for use.

FindInFaxL()

private: void FindInFaxL(const TDesC& aTextToFind, TMsvPartList aPartList, TMsvPartList& rReturnList);

Description

This member is internal and not intended for use.

FindInBodyL()

private: TMsvPartList FindInBodyL(const TDesC& aTextToFind, CMsvFindText& aMsvFindText);

Description

This member is internal and not intended for use.

FindInRecipientsL()

private: TMsvPartList FindInRecipientsL(const TDesC& aTextToFind, CMsvFindText& aMsvFindText);

Description

This member is internal and not intended for use.

©2002 Symbian Ltd.

[Top]