NotificationManagerInterface Class Reference

#include <notificationmanagerinterface.h>

Inheritance diagram for NotificationManagerInterface:

List of all members.

Public Slots
virtual bool	removeNotification (uint notificationUserId, uint notificationId)=0
Public Member Functions
virtual uint	addNotification (uint notificationUserId, const NotificationParameters &parameters=NotificationParameters(), uint groupId=0)=0
virtual bool	updateNotification (uint notificationUserId, uint notificationId, const NotificationParameters &parameters=NotificationParameters())=0
virtual uint	addGroup (uint notificationUserId, const NotificationParameters &parameters=NotificationParameters())=0
virtual bool	updateGroup (uint notificationUserId, uint groupId, const NotificationParameters &parameters=NotificationParameters())=0
virtual bool	removeGroup (uint notificationUserId, uint groupId)=0
virtual uint	notificationUserId ()=0
virtual QList< uint >	notificationIdList (uint notificationUserId)=0
virtual QList< MNotificationProxy >	notificationList (uint notificationUserId)=0
virtual QList < MNotificationWithIdentifierProxy >	notificationListWithIdentifiers (uint notificationUserId)=0
virtual QList < MNotificationGroupProxy >	notificationGroupList (uint notificationUserId)=0
virtual QList < MNotificationGroupWithIdentifierProxy >	notificationGroupListWithIdentifiers (uint notificationUserId)=0

---

Detailed Description

Abstract notification manager interface. Declares interface for adding, updating, removing individual notifications as well as adding a notification to the group, updating and removing the group.

Definition at line 38 of file notificationmanagerinterface.h.

---

Member Function Documentation

virtual uint NotificationManagerInterface::addGroup	(	uint	notificationUserId,
		const NotificationParameters &	parameters = NotificationParameters()
	)			[pure virtual]

Adds a new notification group. Later on notifications can be added to this group.

Parameters:

	notificationUserId	the ID of the user of notifications
	parameters	Parameters for the notification group

Returns:

the new group id.

Implemented in NotificationManager.

virtual uint NotificationManagerInterface::addNotification	(	uint	notificationUserId,
		const NotificationParameters &	parameters = NotificationParameters(),
		uint	groupId = 0
	)			[pure virtual]

Adds a notification. Optionally adds the notification to a notification group. The default group number 0 means that the notification is not added to any group. You can create groups by calling addGroup.

If an invalid group ID is given the notification is not added. In this case 0 is returned.

Parameters:

	notificationUserId	the ID of the user of notifications
	parameters	Parameters for the notification
	groupId	A notification group where this notification is added.
	type	the type of the notification.

Returns:

a notification ID.

See also:

addGroup

Implemented in NotificationManager.

virtual QList<MNotificationGroupProxy> NotificationManagerInterface::notificationGroupList

(

uint

notificationUserId

)

[pure virtual]

Returns list of notification groups by user id

Parameters:

notificationUserId

the ID of the user of notifications

Returns:

list of notification groups that belong to notificationUserId

Implemented in NotificationManager.

virtual QList<MNotificationGroupWithIdentifierProxy> NotificationManagerInterface::notificationGroupListWithIdentifiers

(

uint

notificationUserId

)

[pure virtual]

Returns list of notification groups with identifiers by user id

Parameters:

notificationUserId

the ID of the user of notifications

Returns:

list of notification groups with identifiers that belong to notificationUserId

Implemented in NotificationManager.

virtual QList<uint> NotificationManagerInterface::notificationIdList

(

uint

notificationUserId

)

[pure virtual]

Returns list of notification ids by user id

Parameters:

notificationUserId

the ID of the user of notifications

Returns:

list of notification ids that belong to notificationUserId

Implemented in NotificationManager.

virtual QList<MNotificationProxy> NotificationManagerInterface::notificationList

(

uint

notificationUserId

)

[pure virtual]

Returns list of notifications by user id

Parameters:

notificationUserId

the ID of the user of notifications

Returns:

list of notifications that belong to notificationUserId

Implemented in NotificationManager.

virtual QList<MNotificationWithIdentifierProxy> NotificationManagerInterface::notificationListWithIdentifiers

(

uint

notificationUserId

)

[pure virtual]

Returns list of notifications with identifiers by user id

Parameters:

notificationUserId

the ID of the user of notifications

Returns:

list of notifications with identifiers that belong to notificationUserId

Implemented in NotificationManager.

virtual uint NotificationManagerInterface::notificationUserId

(

)

[pure virtual]

Returns a user ID for the notification system. The user ID has to be supplied with every notification system call.

Returns:

a user ID for the notification system

Implemented in NotificationManager.

virtual bool NotificationManagerInterface::removeGroup	(	uint	notificationUserId,
		uint	groupId
	)			[pure virtual]

Removes a notification group.

Parameters:

	notificationUserId	the ID of the user of notifications
	groupId	The ID of the notification group to be removed.

Returns:

true if the removal succeeded, false otherwise

Implemented in NotificationManager.

virtual bool NotificationManagerInterface::removeNotification	(	uint	notificationUserId,
		uint	notificationId
	)			[pure virtual, slot]

Removes a notification.

Parameters:

	notificationUserId	the ID of the user of notifications
	notificationId	The ID of the notification to be removed.

Returns:

true if the removal succeeded, false otherwise

Implemented in NotificationManager.

virtual bool NotificationManagerInterface::updateGroup	(	uint	notificationUserId,
		uint	groupId,
		const NotificationParameters &	parameters = NotificationParameters()
	)			[pure virtual]

Updates the contents of a notification group.

Parameters:

	notificationUserId	the ID of the user of notifications
	groupId	The ID of the notification group to be updated
	parameters	Parameters for the notification group

Returns:

true if the update succeeded, false otherwise

Implemented in NotificationManager.

virtual bool NotificationManagerInterface::updateNotification	(	uint	notificationUserId,
		uint	notificationId,
		const NotificationParameters &	parameters = NotificationParameters()
	)			[pure virtual]

Updates a notification.

Parameters:

	notificationUserId	the ID of the user of notifications
	notificationId	The ID of the notification to be updated
	parameters	Parameters for the notification

Returns:

true if the update succeeded, false otherwise

Implemented in NotificationManager.

---

The documentation for this class was generated from the following file:

• src/systemui/notifications/notificationmanagerinterface.h (da86b1516605986593da446e3735ddbd2af0f038)