Notification

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/Notification>

To link against this class, add the following line to your .pro file: LIBS += -lbbpim

The Notification class represents an email notification that's sent to the participants of a meeting.

This class contains data for a notification email that's sent to the participants of a created, changed, or cancelled meeting. This class includes information such as added and deleted participants that will be notified, user comments, and account ID.


Overview

Public Functions Index

Notification ()
Notification (const Notification &other)
~Notification ()
AccountIdaccountId () const
voidaddDeletedAttendeeEmail (const QString &deletedAttendeeEmail)
voidaddNewAttendeeEmail (const QString &newAttendeeEmail)
QStringcomments () const
QStringListdeletedAttendeeEmails () const
boolisNotifyAll () const
boolisValid () const
AccountIdmessageAccountId () const
QStringListnewAttendeeEmails () const
Notification &operator= (const Notification &other)
voidresetDeletedAttendeeEmails ()
voidresetNewAttendeeEmails ()
voidsetAccountId (AccountId accountId)
voidsetComments (const QString &comments)
voidsetDeletedAttendeeEmails (const QStringList &deletedAttendeeEmails)
voidsetMessageAccountId (AccountId messageAccountId)
voidsetNewAttendeeEmails (const QStringList &newAttendeeEmails)
voidsetNotifyAll (bool notifyAll)

Public Functions

Notification ()

Constructs a new Notification.

Since:

BlackBerry 10.0.0

Notification (

Copy constructor.

This function constructs a Notification containing exactly the same values as the provided Notification.

Parameters
other

The Notification to be copied.

Since:

BlackBerry 10.0.0

~Notification ()

Destructor.

Since:

BlackBerry 10.0.0

AccountId accountId ()

Retrieves the account ID for this Notification.

This function returns the ID for the calendar account containing the event referred to by the notification.

Return:

The account ID for this Notification.

Since:

BlackBerry 10.0.0

void addDeletedAttendeeEmail (
  • const QString &deletedAttendeeEmail)

Adds a deleted attendee to this Notification.

This function appends a deleted attendee to the existing list of deleted attendees.

Parameters
deletedAttendeeEmail

The deleted attendee to add.

Since:

BlackBerry 10.0.0

void addNewAttendeeEmail (

Adds a new attendee to this Notification.

This function appends a new attendee to the existing list of new attendees.

Parameters
newAttendeeEmail

The new attendee to add.

Since:

BlackBerry 10.0.0

QString comments ()

Retrieves the user comments for this Notification.

This function returns the comments by the user on the meeting that was created, changed, or cancelled.

Return:

The user comments for this Notification.

Since:

BlackBerry 10.0.0

QStringList deletedAttendeeEmails ()

Retrieves the removed participants that will be notified by this Notification.

This function returns the list of participants that were removed from the meeting, to whom the notification will be sent.

Return:

The removed participants.

Since:

BlackBerry 10.0.0

bool isNotifyAll ()

Indicates whether this Notification should be sent to all participants.

Return:

true if the notification should be sent to all participants of the meeting, false otherwise.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this Notification is valid.

This function determines whether the attributes of this Notification object have acceptable values.

Return:

true if this Notification is valid, false otherwise.

Since:

BlackBerry 10.0.0

AccountId messageAccountId ()

Retrieves the messaging account ID for this Notification.

This function returns the identifier of the messaging account to be used to send the notification.

Return:

The messaging account ID for this Notification.

Since:

BlackBerry 10.0.0

QStringList newAttendeeEmails ()

Retrieves the added participants that will be notified by this Notification.

This function returns the list of participants that were added to the meeting, to whom the notification will be sent.

Return:

The added participants.

Since:

BlackBerry 10.0.0

Notification & operator= (

Assignment operator.

This operator copies all values from the provided Notification into this Notification.

Parameters
other

The Notification from which to copy all values.

Return:

A reference to this Notification.

Since:

BlackBerry 10.0.0

void resetDeletedAttendeeEmails ()

Removes all deleted attendees from this Notification.

Since:

BlackBerry 10.0.0

void resetNewAttendeeEmails ()

Removes all new attendees from this Notification.

Since:

BlackBerry 10.0.0

void setAccountId (
  • AccountIdaccountId)

Sets the account ID for this Notification.

Parameters
accountId

The new account ID.

Since:

BlackBerry 10.0.0

void setComments (

Sets the user comments for this Notification.

Parameters
comments

The new user comments.

Since:

BlackBerry 10.0.0

void setDeletedAttendeeEmails (

Sets the list of deleted attendees for this Notification.

This function replaces the current list of deleted attendees with the provided list.

Parameters
deletedAttendeeEmails

The new list of deleted attendees.

Since:

BlackBerry 10.0.0

void setMessageAccountId (
  • AccountIdmessageAccountId)

Sets the messaging account ID for this Notification.

Parameters
messageAccountId

The new messaging account ID.

Since:

BlackBerry 10.0.0

void setNewAttendeeEmails (

Sets the list of new attendees for this Notification.

This function replaces the current list of new attendees with the provided list.

Parameters
newAttendeeEmails

The new list of new attendees.

Since:

BlackBerry 10.0.0

void setNotifyAll (
  • boolnotifyAll)

Sets whether this Notification should be sent to all participants.

Parameters
notifyAll

If true the notification is sent to all participants, if false the notification is not sent to all participants.

Since:

BlackBerry 10.0.0

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus