EventRefresh

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/EventRefresh>

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

The EventRefresh class represents a notification for added, changed, or deleted events.

An EventRefresh object is sent by the calendar service whenever events are created in, updated in, or removed from the local database. This object contains information about the events that were created, updated, or removed, such as event IDs, folder IDs, and account ID.

For example, the CalendarService::eventsRefreshed() signal is emitted when there are changes to events in the database. This signal includes an EventRefresh parameter that contains the details of the refresh.

See also:

CalendarService


Overview

Public Functions Index

EventRefresh ()
EventRefresh (const EventRefresh &other)
~EventRefresh ()
AccountIdaccount () const
voidaddCreatedEventId (EventId createdEventId)
voidaddDeletedEventId (EventId deletedEventId)
voidaddUpdatedEventId (EventId updatedEventId)
voidaddUpdatedFolderId (FolderId updatedFolderId)
QList< EventId >createdEventIds () const
QList< EventId >deletedEventIds () const
boolisValid () const
EventRefresh &operator= (const EventRefresh &other)
voidresetCreatedEventIds ()
voidresetDeletedEventIds ()
voidresetUpdatedEventIds ()
voidresetUpdatedFolderIds ()
voidsetAccount (AccountId account)
voidsetCreatedEventIds (const QList< EventId > &createdEventIds)
voidsetDeletedEventIds (const QList< EventId > &deletedEventIds)
voidsetUpdatedEventIds (const QList< EventId > &updatedEventIds)
voidsetUpdatedFolderIds (const QList< FolderId > &updatedFolderIds)
QList< EventId >updatedEventIds () const
QList< FolderId >updatedFolderIds () const

Public Functions

EventRefresh ()

Constructs a new EventRefresh.

Since:

BlackBerry 10.0.0

EventRefresh (

Copy constructor.

This function constructs an EventRefresh containing exactly the same values as the provided EventRefresh.

Parameters
other

The EventRefresh to be copied.

Since:

BlackBerry 10.0.0

~EventRefresh ()

Destructor.

Since:

BlackBerry 10.0.0

AccountId account ()

Retrieves the account ID of this EventRefresh.

This function returns the identifier for the account that owns the added, changed, or removed events.

Return:

The account ID of this EventRefresh.

Since:

BlackBerry 10.0.0

void addCreatedEventId (
  • EventIdcreatedEventId)

Adds the ID of a created event to this EventRefresh.

This function appends a new ID to the existing list of created event IDs.

Parameters
createdEventId

The event ID to add.

Since:

BlackBerry 10.0.0

void addDeletedEventId (
  • EventIddeletedEventId)

Adds the ID of a deleted event to this EventRefresh.

This function appends a new ID to the existing list of deleted event IDs.

Parameters
deletedEventId

The event ID to add.

Since:

BlackBerry 10.0.0

void addUpdatedEventId (
  • EventIdupdatedEventId)

Adds the ID of an updated event to this EventRefresh.

This function appends a new ID to the existing list of updated event IDs.

Parameters
updatedEventId

The event ID to add.

Since:

BlackBerry 10.0.0

void addUpdatedFolderId (
  • FolderIdupdatedFolderId)

Adds the ID of an updated folder to this EventRefresh.

This function appends a new ID to the existing list of updated folder IDs.

Parameters
updatedFolderId

The folder ID to add.

Since:

BlackBerry 10.0.0

QList< EventId > createdEventIds ()

Retrieves the list of IDs of created events.

This function returns a list that includes the IDs of events that were created in the local database.

Return:

The list of IDs of created events.

Since:

BlackBerry 10.0.0

QList< EventId > deletedEventIds ()

Retrieves the list of IDs of deleted events.

This function returns a list that includes the IDs of events that were deleted from the local database.

Return:

The list of IDs of deleted events.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this EventRefresh is valid.

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

Return:

true if this EventRefresh is valid, false otherwise.

Since:

BlackBerry 10.0.0

EventRefresh & operator= (

Assignment operator.

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

Parameters
other

The EventRefresh from which to copy all values.

Return:

A reference to this EventRefresh.

Since:

BlackBerry 10.0.0

void resetCreatedEventIds ()

Removes all created event IDs from this EventRefresh.

Since:

BlackBerry 10.0.0

void resetDeletedEventIds ()

Removes all deleted event IDs from this EventRefresh.

Since:

BlackBerry 10.0.0

void resetUpdatedEventIds ()

Removes all updated event IDs from this EventRefresh.

Since:

BlackBerry 10.0.0

void resetUpdatedFolderIds ()

Removes all updated folder IDs from this EventRefresh.

Since:

BlackBerry 10.0.0

void setAccount (
  • AccountIdaccount)

Sets the account ID of this EventRefresh.

Parameters
account

The new account ID.

Since:

BlackBerry 10.0.0

void setCreatedEventIds (
  • const QList< EventId > &createdEventIds)

Sets the list of created event IDs for this EventRefresh.

This function replaces the current list of created event IDs with the provided list.

Parameters
createdEventIds

The new list of created event IDs.

Since:

BlackBerry 10.0.0

void setDeletedEventIds (
  • const QList< EventId > &deletedEventIds)

Sets the list of deleted event IDs for this EventRefresh.

This function replaces the current list of deleted event IDs with the provided list.

Parameters
deletedEventIds

The new list of deleted event IDs.

Since:

BlackBerry 10.0.0

void setUpdatedEventIds (
  • const QList< EventId > &updatedEventIds)

Sets the list of updated event IDs for this EventRefresh.

This function replaces the current list of updated event IDs with the provided list.

Parameters
updatedEventIds

The new list of updated event IDs.

Since:

BlackBerry 10.0.0

void setUpdatedFolderIds (
  • const QList< FolderId > &updatedFolderIds)

Sets the list of updated folder IDs for this EventRefresh.

This function replaces the current list of updated folder IDs with the provided list.

Parameters
updatedFolderIds

The new list of updated folder IDs.

Since:

BlackBerry 10.0.0

QList< EventId > updatedEventIds ()

Retrieves the list of IDs of updated events.

This function returns a list that includes the IDs of events that were changed or updated in the local database.

Return:

The list of IDs of updated events.

Since:

BlackBerry 10.0.0

QList< FolderId > updatedFolderIds ()

Retrieves the list of IDs of updated folders.

This function returns a list that includes the IDs of folders in which events were added, deleted, or changed.

Return:

The list of IDs of updated folders.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus