Home · All Namespaces · All Classes
Public Member Functions

DBusInterfaceNotificationSource Class Reference

#include <dbusinterfacenotificationsource.h>

Inheritance diagram for DBusInterfaceNotificationSource:
Inheritance graph
[legend]
Collaboration diagram for DBusInterfaceNotificationSource:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 DBusInterfaceNotificationSource (NotificationManagerInterface &interface)
uint notificationUserId ()
uint addNotification (uint notificationUserId, uint groupId, const QString &eventType)
uint addNotification (uint notificationUserId, uint groupId, const QString &eventType, const QString &summary, const QString &body, const QString &action, const QString &imageURI, uint count)
uint addNotification (uint notificationUserId, uint groupId, const QString &eventType, const QString &summary, const QString &body, const QString &action, const QString &imageURI, uint count, const QString &identifier)
bool updateNotification (uint notificationUserId, uint notificationId, const QString &eventType)
bool updateNotification (uint notificationUserId, uint notificationId, const QString &eventType, const QString &summary, const QString &body, const QString &action, const QString &imageURI, uint count)
bool updateNotification (uint notificationUserId, uint notificationId, const QString &eventType, const QString &summary, const QString &body, const QString &action, const QString &imageURI, uint count, const QString &identifier)
bool removeNotification (uint notificationUserId, uint notificationId)
uint addGroup (uint notificationUserId, const QString &eventType)
uint addGroup (uint notificationUserId, const QString &eventType, const QString &summary, const QString &body, const QString &action, const QString &imageURI, uint count)
uint addGroup (uint notificationUserId, const QString &eventType, const QString &summary, const QString &body, const QString &action, const QString &imageURI, uint count, const QString &identifier)
bool updateGroup (uint notificationUserId, uint groupId, const QString &eventType)
bool updateGroup (uint notificationUserId, uint groupId, const QString &eventType, const QString &summary, const QString &body, const QString &action, const QString &imageURI, uint count)
bool updateGroup (uint notificationUserId, uint groupId, const QString &eventType, const QString &summary, const QString &body, const QString &action, const QString &imageURI, uint count, const QString &identifier)
bool removeGroup (uint notificationUserId, uint groupId)
QList< uint > notificationIdList (uint notificationUserId)
QList< MNotificationProxynotificationList (uint notificationUserId)
QList
< MNotificationWithIdentifierProxy
notificationListWithIdentifiers (uint notificationUserId)
QList< MNotificationGroupProxynotificationGroupList (uint notificationUserId)
QList
< MNotificationGroupWithIdentifierProxy
notificationGroupListWithIdentifiers (uint notificationUserId)
uint notificationCountInGroup (uint notificationUserId, uint groupId)

Detailed Description

Publishes a D-Bus interface with which application developers can create and manage notifications.

DBusInterfaceNotificationSourceAdaptor defines the D-Bus API which calls this source to trigger the notifications.

The new API can be tested using the following commands:

dbus-send --print-reply --dest=com.meego.core.MNotificationManager /notificationmanager com.meego.core.MNotificationManager.notificationUserId dbus-send --print-reply --dest=com.meego.core.MNotificationManager /notificationmanager com.meego.core.MNotificationManager.addNotification uint32:<return_val_from_previous_cmd> uint32:0 string:'new-message' string:'Message received' string:'Hello M' string:'link' string:'Icon-close' uint32:1


Constructor & Destructor Documentation

DBusInterfaceNotificationSource::DBusInterfaceNotificationSource ( NotificationManagerInterface interface  ) 

Creates a new DBusInterfaceNotitificationSource.

Parameters:
interface the NotificationManagerInterface to post the notifications to

Member Function Documentation

uint DBusInterfaceNotificationSource::addGroup ( uint  notificationUserId,
const QString &  eventType 
)

Adds a new notification group.

Parameters:
notificationUserId the ID of the user of notifications
eventType the event type of the notification
Returns:
the ID of the new notification group
uint DBusInterfaceNotificationSource::addGroup ( uint  notificationUserId,
const QString &  eventType,
const QString &  summary,
const QString &  body,
const QString &  action,
const QString &  imageURI,
uint  count 
)

Adds a new notification group.

Parameters:
notificationUserId the ID of the user of notifications
eventType the event type of the notification
summary the summary text to be used in the notification
body the body text to be used in the notification
action the ID of the content to be used in the notification
imageURI the ID of the icon to be used in the notification
count the number of items inside this group
Returns:
the ID of the new notification group
uint DBusInterfaceNotificationSource::addGroup ( uint  notificationUserId,
const QString &  eventType,
const QString &  summary,
const QString &  body,
const QString &  action,
const QString &  imageURI,
uint  count,
const QString &  identifier 
)

Adds a new notification group.

Parameters:
notificationUserId the ID of the user of notifications
eventType the event type of the notification
summary the summary text to be used in the notification
body the body text to be used in the notification
action the ID of the content to be used in the notification
imageURI the ID of the icon to be used in the notification
count the number of items inside this group
identifier the user supplied identifier
Returns:
the ID of the new notification group
uint DBusInterfaceNotificationSource::addNotification ( uint  notificationUserId,
uint  groupId,
const QString &  eventType,
const QString &  summary,
const QString &  body,
const QString &  action,
const QString &  imageURI,
uint  count,
const QString &  identifier 
)

Adds a new notification.

Parameters:
notificationUserId the ID of the user of notifications
groupId the ID of the notification group to put the notification in
eventType the event type of the notification
summary the summary text to be used in the notification
body the body text to be used in the notification
action the ID of the content to be used in the notification
imageURI the ID of the icon to be used in the notification
count the number of items inside this notification
identifier the user supplied identifier
Returns:
the ID of the new notification
uint DBusInterfaceNotificationSource::addNotification ( uint  notificationUserId,
uint  groupId,
const QString &  eventType 
)

Adds a new notification.

Parameters:
notificationUserId the ID of the user of notifications
groupId the ID of the notification group to put the notification in
eventType the event type of the notification
Returns:
the ID of the new notification
uint DBusInterfaceNotificationSource::addNotification ( uint  notificationUserId,
uint  groupId,
const QString &  eventType,
const QString &  summary,
const QString &  body,
const QString &  action,
const QString &  imageURI,
uint  count 
)

Adds a new notification.

Parameters:
notificationUserId the ID of the user of notifications
groupId the ID of the notification group to put the notification in
eventType the event type of the notification
summary the summary text to be used in the notification
body the body text to be used in the notification
action the ID of the content to be used in the notification
imageURI the ID of the icon to be used in the notification
count the number of items inside this notification
Returns:
the ID of the new notification
uint DBusInterfaceNotificationSource::notificationCountInGroup ( uint  notificationUserId,
uint  groupId 
)

Returns amount of notifications in a given group

Parameters:
notificationUserId the ID of the user of notifications
groupId the group ID
Returns:
amount of notifications in given group
QList< MNotificationGroupProxy > DBusInterfaceNotificationSource::notificationGroupList ( uint  notificationUserId  ) 

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
QList< MNotificationGroupWithIdentifierProxy > DBusInterfaceNotificationSource::notificationGroupListWithIdentifiers ( uint  notificationUserId  ) 

Returns list of notification groups with associated identifiers by user id

Parameters:
notificationUserId the ID of the user of notifications
Returns:
list of notification groups with associated identifiers that belong to notificationUserId
QList< uint > DBusInterfaceNotificationSource::notificationIdList ( uint  notificationUserId  ) 

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
QList< MNotificationProxy > DBusInterfaceNotificationSource::notificationList ( uint  notificationUserId  ) 

Returns list of notifications by user id

Parameters:
notificationUserId the ID of the user of notifications
Returns:
list of notifications that belong to notificationUserId
QList< MNotificationWithIdentifierProxy > DBusInterfaceNotificationSource::notificationListWithIdentifiers ( uint  notificationUserId  ) 

Returns list of notifications with associated identifiers by user id

Parameters:
notificationUserId the ID of the user of notifications
Returns:
list of notifications with associated identifiers that belong to notificationUserId
uint DBusInterfaceNotificationSource::notificationUserId (  ) 

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
bool DBusInterfaceNotificationSource::removeGroup ( uint  notificationUserId,
uint  groupId 
)

Removes a notification group and all notifications in the 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
bool DBusInterfaceNotificationSource::removeNotification ( uint  notificationUserId,
uint  notificationId 
)

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
bool DBusInterfaceNotificationSource::updateGroup ( uint  notificationUserId,
uint  groupId,
const QString &  eventType,
const QString &  summary,
const QString &  body,
const QString &  action,
const QString &  imageURI,
uint  count 
)

Updates an existing notification group.

Parameters:
notificationUserId the ID of the user of notifications
groupId the ID of the notification group to be updated
eventType the event type of the notification
summary the summary text to be used in the notification
body the body text to be used in the notification
action the ID of the content to be used in the notification
imageURI the ID of the icon to be used in the notification
count the number of items inside this group
Returns:
true if the update succeeded, false otherwise
bool DBusInterfaceNotificationSource::updateGroup ( uint  notificationUserId,
uint  groupId,
const QString &  eventType,
const QString &  summary,
const QString &  body,
const QString &  action,
const QString &  imageURI,
uint  count,
const QString &  identifier 
)

Updates an existing notification group.

Parameters:
notificationUserId the ID of the user of notifications
groupId the ID of the notification group to be updated
eventType the event type of the notification
summary the summary text to be used in the notification
body the body text to be used in the notification
action the ID of the content to be used in the notification
imageURI the ID of the icon to be used in the notification
count the number of items inside this group
identifier the user supplied identifier
Returns:
true if the update succeeded, false otherwise
bool DBusInterfaceNotificationSource::updateGroup ( uint  notificationUserId,
uint  groupId,
const QString &  eventType 
)

Updates an existing notification group.

Parameters:
notificationUserId the ID of the user of notifications
groupId the ID of the notification group to be updated
eventType the event type of the notification
Returns:
true if the update succeeded, false otherwise
bool DBusInterfaceNotificationSource::updateNotification ( uint  notificationUserId,
uint  notificationId,
const QString &  eventType 
)

Updates an existing notification.

Parameters:
notificationUserId the ID of the user of notifications
notificationId the ID of the notification to be updated
eventType the event type of the notification
Returns:
true if the update succeeded, false otherwise
bool DBusInterfaceNotificationSource::updateNotification ( uint  notificationUserId,
uint  notificationId,
const QString &  eventType,
const QString &  summary,
const QString &  body,
const QString &  action,
const QString &  imageURI,
uint  count 
)

Updates an existing notification.

Parameters:
notificationUserId the ID of the user of notifications
notificationId the ID of the notification to be updated
eventType the event type of the notification
summary the summary text to be used in the notification
body the body text to be used in the notification
action the ID of the content to be used in the notification
imageURI the ID of the icon to be used in the notification
count the number of items inside this notification
Returns:
true if the update succeeded, false otherwise
bool DBusInterfaceNotificationSource::updateNotification ( uint  notificationUserId,
uint  notificationId,
const QString &  eventType,
const QString &  summary,
const QString &  body,
const QString &  action,
const QString &  imageURI,
uint  count,
const QString &  identifier 
)

Updates an existing notification.

Parameters:
notificationUserId the ID of the user of notifications
notificationId the ID of the notification to be updated
eventType the event type of the notification
summary the summary text to be used in the notification
body the body text to be used in the notification
action the ID of the content to be used in the notification
imageURI the ID of the icon to be used in the notification
count the number of items inside this notification
identifier the user supplied identifier
Returns:
true if the update succeeded, false otherwise

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

Copyright © 2011 Nokia Corporation Generated on Tue Aug 30 2011 16:38:12
Doxygen 1.7.1
MeeGo Touch