AccountsChanged

Since: BlackBerry 10.0.0

#include <bb/pim/account/AccountsChanged>

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

The AccountsChanged class provides the necessary information to the client regarding changes that have taken place on Account objects stored on the device.

When an account is added, updated or deleted by the device core application or some third-party application running on the device, it may be necessary for other applications to be made aware of these changes. The signal AccountService::accountsChanged is provided for clients that want to respond to such account changes. This particular signal will include an AccountsChanged object that will contain the account ids of any added, updated, and deleted accounts.


Overview

Public Functions Index

AccountsChanged ()
AccountsChanged (const AccountsChanged &other)
~AccountsChanged ()
QList< AccountKey >connectedAccountIds () const
QList< AccountKey >createdAccountIds () const
QList< AccountKey >deletedAccountIds () const
QList< AccountKey >invalidatedAccountIds () const
AccountsChanged &operator= (const AccountsChanged &other)
QList< AccountKey >syncedAccountIds () const
QList< AccountKey >syncStartedAccountIds () const
QList< AccountKey >updatedAccountIds () const

Protected Functions Index

voidsetConnectedAccountIds (const QList< AccountKey > &connectedAccountIds)
voidsetCreatedAccountIds (const QList< AccountKey > &createdAccountIds)
voidsetDeletedAccountIds (const QList< AccountKey > &deletedAccountIds)
voidsetInvalidatedAccountIds (const QList< AccountKey > &invalidatedAccountIds)
voidsetSyncedAccountIds (const QList< AccountKey > &syncedAccountIds)
voidsetSyncStartedAccountIds (const QList< AccountKey > &syncStartedAccountIds)
voidsetUpdatedAccountIds (const QList< AccountKey > &updatedAccountIds)

Public Functions

AccountsChanged ()

Creates a new AccountsChanged object.

Since:

BlackBerry 10.0.0

AccountsChanged (

Creates a copy of an existing AccountsChanged object.

Parameters
other

The AccountsChanged object to be copied.

Since:

BlackBerry 10.0.0

~AccountsChanged ()

Destructor.

Since:

BlackBerry 10.0.0

QList< AccountKey > connectedAccountIds ()

Represents the newly-authenticated accounts sent with the signal AccountService::accountsChanged().

Return:

Returns a QList containing the id of all newly-authenticated Account objects.

Since:

BlackBerry 10.1.0

QList< AccountKey > createdAccountIds ()

Represents the newly-created accounts sent with the signal AccountService::accountsChanged.

Return:

Returns a QList containing the id of all newly-created Account objects.

Since:

BlackBerry 10.0.0

QList< AccountKey > deletedAccountIds ()

Represents the newly-deleted accounts sent with the signal AccountService::accountsChanged.

Return:

Returns a QList containing the id of all newly-deleted Account objects.

Since:

BlackBerry 10.0.0

QList< AccountKey > invalidatedAccountIds ()

Represents the newly-invalidated accounts sent with the signal AccountService::accountsChanged().

Return:

Returns a QList containing the id of all newly-invalidated Account objects.

Since:

BlackBerry 10.1.0

AccountsChanged & operator= (

Copies the data of an existing AccountsChanged object to this object.

Parameters
other

The AccountsChanged object to be copied.

Return:

Returns the AccountsChanged instance.

Since:

BlackBerry 10.0.0

QList< AccountKey > syncedAccountIds ()

Represents the newly-synced accounts sent with the signal AccountService::accountsChanged().

Return:

Returns a QList containing the id of all newly-synced Account objects.

Since:

BlackBerry 10.1.0

QList< AccountKey > syncStartedAccountIds ()

Represents the accounts that have just started syncing sent with the signal AccountService::accountsChanged().

Return:

Returns a QList containing the id of all Account objects that have just started syncing.

Since:

BlackBerry 10.1.0

QList< AccountKey > updatedAccountIds ()

Represents the newly-updated accounts sent with the signal AccountService::accountsChanged.

Return:

Returns a QList containing the id of all newly-updated Account objects.

Since:

BlackBerry 10.0.0

Protected Functions

void setConnectedAccountIds (
  • const QList< AccountKey > &connectedAccountIds)

Set function for newly-authenticated accounts to be sent with the signal AccountService::accountsChanged().

Prior to receiving this signal, these accounts aren't necessarily in an invalid or disconnected state.

Parameters
connectedAccountIds

A QList containing the id of all newly-authenticated Account objects to be sent.

Since:

BlackBerry 10.1.0

void setCreatedAccountIds (
  • const QList< AccountKey > &createdAccountIds)

Set function for the newly-created accounts to be sent with the signal AccountService::accountsChanged.

Parameters
createdAccountIds

The QList containing the id of all newly-created Account objects to be sent.

Since:

BlackBerry 10.0.0

void setDeletedAccountIds (
  • const QList< AccountKey > &deletedAccountIds)

Set function for the newly-deleted accounts to be sent with the signal AccountService::accountsChanged.

Parameters
deletedAccountIds

The QList containing the id of all newly-deleted Account objects to be sent.

Since:

BlackBerry 10.0.0

void setInvalidatedAccountIds (
  • const QList< AccountKey > &invalidatedAccountIds)

Set function for newly-invalidated accounts to be sent with the signal AccountService::accountsChanged().

Parameters
invalidatedAccountIds

A QList containing the id of all newly-invalidated Account objects to be sent.

Since:

BlackBerry 10.1.0

void setSyncedAccountIds (
  • const QList< AccountKey > &syncedAccountIds)

Set function for newly-synced accounts to be sent with the signal AccountService::accountsChanged().

Parameters
syncedAccountIds

A QList containing the id of all newly-synced Account objects to be sent.

Since:

BlackBerry 10.1.0

void setSyncStartedAccountIds (
  • const QList< AccountKey > &syncStartedAccountIds)

Set function for the accounts that have just started syncing to be sent with the signal AccountService::accountsChanged().

Parameters
syncStartedAccountIds

A QList containing the id of all Account objects that have just started syncing to be sent.

Since:

BlackBerry 10.1.0

void setUpdatedAccountIds (
  • const QList< AccountKey > &updatedAccountIds)

Set function for the newly-updated accounts to be sent with the signal AccountService::accountsChanged.

Parameters
updatedAccountIds

The QList containing the id of all newly-updated Account objects to be sent.

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