Class CImFramework

class CImFramework : public CBase, public MIMPluginObserver;

Description

Framework

Derivation

• MIMPluginObserver - MIMPluginObserver is used by plug-ins to notify the IM framework
• CBase - Base class for all classes to be instantiated on the heap
• CImFramework - Framework

Members

Defined in CImFramework:
CancelAllNotificationsL(), CancelAnyMessageNotificationL(), CancelContactNotificationL(), FindIMIdentityL(), GetApplicationIconL(), GetAvailableStatusesInServiceL(), GetDefaultIconL(), GetListOfServicesL(), GetMessageIconL(), GetViewUidForAction(), NewL(), RequestAnyMessageNotificationL(), RequestContactNotificationL(), RequestUsersPresenceStatusL(), RequestedContacts(), SetImFwObserver(), SetUsersPresenceStatusL(), iApp

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from MIMPluginObserver:
AllMessageReadL(), ImIdentityRemovedL(), InstallL(), MessageReadContactL(), NewMessageContactL(), NewMessageL(), OfflineL(), PresenceStatusL(), UninstallL(), UsersPresenceStatusL()

static IMPORT_C CImFramework *NewL();

Description

NewL is a static construction method.

Return value

IMPORT_C TBool RequestContactNotificationL(const TUint32 &aServiceId, const TDesC &aImUserId, TContactItemId aCntId);

Description

A phonebook application, for example Contacts, can subscribe to Instant Messaging information about one of its listings (often referred to as a contact). The phonebook application sends a signal to the Instant Messaging framework requesting notification of any Instant Messaging activities for the listing. These activities could be changes in status or reception of new messages.

In order to identify the listing, the phonebook application must send the Instant Messaging framework three different IDs. First, the ID of the Instant Messaging service must be sent. This identifies, for example, that ICQ is the service. Next, the ID of the listing as a user of the service is sent. For ICQ this is a several-digit number. Finally, the ID of the listing that is used by the phonebook application itself is sent.

The phonebook application calls RequestContactNotificationL() to establish a subscription for one listing.

To cancel a subscription use CancelContactNotificationL() .

Parameters

Return value

IMPORT_C void CancelContactNotificationL(const TUint32 &aServiceId, const TDesC &aImUserId, TContactItemId aCntId);

Description

A phonebook application uses CancelContactNotificationL to cancel a subscription for information about one of its listings.

To create a subscription, use RequestContactNotificationL().

Parameters

IMPORT_C void CancelAllNotificationsL(const TUint32 &aServiceId);

Description

A phonebook application uses CancelAllNotificationsL() to cancel all subscriptions for information about its listings from one Instanst Messaging service.

Parameters

IMPORT_C void RequestAnyMessageNotificationL();

Description

A phonebook application may wish to notify the user that message has been received from an Instant Messaging service without specifying the service or the listing that is involved.

The phonebook application calls RequestAnyMessageNotificationL() to request notification when a message is recieved by any Instant Messaging service.

Use CancelAnyMessageNotificationL() to remove this request.

IMPORT_C void CancelAnyMessageNotificationL();

Description

When a phonebook application no longer wishes to be notified of messages that are received by any Instant Messaging service, it calls CancelAnyMessageNotificationL() .

To request notification, the phonebook application calls RequestAnyMessageNotificationL() .

IMPORT_C void RequestUsersPresenceStatusL(const TUint32 &aServiceId);

Description

When a phonebook application wants to find out the current presence status of the user for a specific instant messaging service, it calls RequestUsersPresenceStatusL() .

Parameters

IMPORT_C CImStatusArray *GetAvailableStatusesInServiceL(const TUint32 &aServiceId);

Description

When a phonebook application wants to get a list of possible statuses a user can choose from for a specific Instant Messaging service, it calls GetAvailableStatusesInServiceL() .

An array of statuses will be returned to the phonebook application. Owership of the array will be transferred to the phonebook application.

Parameters

Return value

IMPORT_C void SetUsersPresenceStatusL(const TUint32 &aServiceId, TUint32 aStatusId, const TDesC &aDescription);

Description

A phonebook application calls SetUsersPresenceStatusL() to change the presence status of the user for a specific Instant Messaging service.

Parameters

IMPORT_C const TDesC &FindIMIdentityL(const TUint32 &aServiceId, const TDesC &aFirstName, const TDesC &aLastName, const TDesC &aMailAddress);

Description

The application that provides an Instant Messaging service may also provide a search mechanism. Given the name and email address of a listing, the search mechanism could determine the user ID of this person for this Instant Messaging service.

The phonebook application calls FindIMIdentityL() to search for the user ID for a listing for an Instant Messaging service.

If the person is found, the user ID is returned.

Parameters

Return value

IMPORT_C TUid GetViewUidForAction(const TUint32 &aServiceId, TImApplicationAction aAction);

Description

GetViewUidForAction() is called to get the UID of the view used to perform the various actions.

Parameters

Return value

inline void SetImFwObserver(MIMObserver *aFw);

Description

SetImFwObserver is called to set iFw

Parameters

IMPORT_C CImServiceArray *GetListOfServicesL();

Description

GetListOfServicesL() is called to get a list of available Instant Messaging services.

Return value

IMPORT_C CImIcon *GetMessageIconL(const TUint32 &aServiceId);

Description

GetMessageIconL() is called to get the message icon that belongs to a specified Instant Messaging service.

Parameters

Return value

IMPORT_C CImIcon *GetApplicationIconL(const TUint32 &aServiceId);

Description

GetApplicationIconL() is called to get the icon that belongs to the specified Instant Messaging service application.

Parameters

Return value

IMPORT_C CImIcon *GetDefaultIconL();

Description

GetDefaultIconL() is called to get the default icon.

Return value

virtual IMPORT_C CRequestedContacts &RequestedContacts() const;

Description

RequestedContacts() is Called to get access to the list of contacts that are linked to an IM service.

Return value

protected: MIMObserver * iApp;

Description

A pointer to the framework observing this plug-in.