Provider

Since: BlackBerry 10.0.0

#include <bb/pim/account/Provider>

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

A Provider.

This class represents a Provider record. The functions in the AccountService class allow you to populate a Provider record and retrieve information from it.


Overview

Public Functions Index

Provider (const Provider &other)
~Provider ()
QList< QString >capabilitiesKeys () const
QVariantcapabilitiesProperty (const QString &key, Property::Field property=Property::Value) const
QStringid () const
Property::EnterpriseTypeisEnterprise () const
boolisServiceAccessReadOnly (Service::Type service) const
boolisServiceSupported (Service::Type service) const
boolisSocial () const
boolisValid () const
QStringname () const
Provider &operator= (const Provider &other)
QVariantMaprawData () const
QList< QString >settingsKeys () const
QVariantsettingsProperty (const QString &key, Property::Field property=Property::Value) const

Protected Functions Index

Provider ()
voidsetEnterprise (Property::EnterpriseType enterprise)
voidsetId (const QString &id)
voidsetName (const QString &name)
voidsetRawData (const QVariantMap &rawData)
voidsetServiceAccessReadOnly (Service::Type service, bool serviceAccessReadOnly)
voidsetServiceSupported (Service::Type service, bool serviceSupported)
voidsetSocial (bool social)
voidsetValid (bool valid)

Public Functions

Provider (

Creates a copy of an existing Provider object.

Parameters
other

The Provider object to be copied.

Since:

BlackBerry 10.0.0

~Provider ()

Destructor.

Since:

BlackBerry 10.0.0

QList< QString > capabilitiesKeys ()

Accessor for the Provider object's capabilities map keys.

Provides access to the Provider object's capabilities map keys.

Return:

Returns a QList containing valid keys that can be used to search the Provider object's capabilities map as well as any capabilities map from an Account object created using this Provider object.

Since:

BlackBerry 10.0.0

QVariant capabilitiesProperty (

Accessor for the Provider object's capabilities map.

Provides access to the capabilities map field contained in the entry key. If the field is not found, it will return QVariant::Invalid.

Parameters
key

The key used to search the capabilities map in order to obtain the capabilities map entry. Use the capabilitiesKeys() function to obtain a list of valid keys.

property

The key used to search the capabilities map entry in order to obtain the field to be returned.

Return:

Returns the Provider object's capabilities field requested. If the capabilities field is not found, it will return QVariant::Invalid.

Since:

BlackBerry 10.0.0

QString id ()

Represents the Provider object's id property.

Provides access to the Provider object's id property. Use the AccountService::providers() function to obtain the complete list of current providers.

Return:

Returns a QString containing the Provider object's id property.

Since:

BlackBerry 10.0.0

Property::EnterpriseType isEnterprise ()

Represents the Provider object's enterprise property.

Provides access to the Provider object's enterprise property. Note: An Account object created using this Provider object will inherit the enterprise property from this Provider object, except for a provider with enterprise set to Property::EnterpriseUnknown. Such a provider may create several types of accounts, some with enterprise set to Property::Enterprise and others with enterprise set to Property::NonEnterprise.

Return:

Returns the Property::EnterpriseType of the Provider object.

Since:

BlackBerry 10.0.0

bool isServiceAccessReadOnly (

Accessor for read-only capability of service.

Returns whether the service is read-only for the provider. If it's not, it implies the service is read-write. Note: An Account object created using this Provider object will inherit the read-only capability for all services from this Provider object. Switching the read-only capability of a service for an account is not possible.

Parameters
service

The service for which we seek the read-only capability from for this Provider object. Possible values are listed in the Service::Type enumeration.

Return:

Returns true if the Provider object's capability to support the service is read-only, and false otherwise.

Since:

BlackBerry 10.0.0

bool isServiceSupported (

Accessor for support capability of service.

Returns whether the service is supported for the provider. Note: An Account object created using this Provider object will inherit the support capability for all services from this Provider object. Switching the support capability of a service for an account from true to false is possible. See the Account::setServiceSupported() function for more details.

Parameters
service

The service for which we seek the supported capability from for this Provider object. Possible values are listed in the Service::Type enumeration.

Return:

Returns true if the Provider object is capable of supporting the service, and false otherwise.

Since:

BlackBerry 10.0.0

bool isSocial ()

Represents the Provider object's social property.

Provides access to the Provider object's social property. Note: An Account object created using this Provider object will inherit the social property from this Provider object.

Return:

Returns true if the Provider object is a provider that creates social accounts, and false otherwise.

Since:

BlackBerry 10.0.0

bool isValid ()

Object correctness.

Determines whether or not the Provider object returned from AccountService function calls has acceptable attribute values.

Return:

Returns true if the Provider object is valid, and false otherwise.

Since:

BlackBerry 10.0.0

QString name ()

Represents the Provider object's name property.

Provides access to the Provider object's name property.

Return:

Returns a QString containing the Provider object's name property.

Since:

BlackBerry 10.0.0

Provider & operator= (

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

Parameters
other

The Provider object to be copied.

Return:

The Provider instance.

Since:

BlackBerry 10.0.0

QVariantMap rawData ()

Represents the Provider object's raw data.

Provides access to the Provider object's raw data.

Return:

Returns a QVariantMap containing the Provider object's raw data.

Since:

BlackBerry 10.0.0

QList< QString > settingsKeys ()

Accessor for the Provider object's settings map keys.

Provides access to the Provider object's settings map keys.

Return:

Returns a QList containing valid keys that can be used to search the Provider object's settings map as well as any settings map from an Account object created using this Provider object.

Since:

BlackBerry 10.0.0

QVariant settingsProperty (

Accessor for the Provider object's settings map.

Provides access to the settings map field contained in the entry key. If the field is not found, it will return QVariant::Invalid.

Parameters
key

The key used to search the settings map in order to obtain the settings map entry. Use the settingsKeys() function to obtain a list of valid keys.

property

The key used to search the settings map entry in order to obtain the field to be returned.

Return:

Returns the Provider object's settings field requested. If the settings field is not found, it will return QVariant::Invalid.

Since:

BlackBerry 10.0.0

Protected Functions

Provider ()

Creates a new Provider object.

Since:

BlackBerry 10.0.0

void setEnterprise (

Set function for Provider object's enterprise property.

Assigns the value of enterprise to the Provider object's enterprise property.

Parameters
enterprise

The value to set.

Since:

BlackBerry 10.0.0

void setId (

Set function for Provider object's id property.

Assigns the value id to the Provider object's id property.

Parameters
id

The value to assign to Provider object's id property.

Since:

BlackBerry 10.0.0

void setName (

Set function for Provider object's name property.

Assigns the value name to the Provider object's name property.

Parameters
name

The value to assign to Provider object's name property.

Since:

BlackBerry 10.0.0

void setRawData (

Set function for Provider object's raw data.

Assigns the value of rawData to the Provider object's raw data.

Parameters
rawData

The value to set.

Since:

BlackBerry 10.0.0

void setServiceAccessReadOnly (

Set function for read-only capability of service.

Assigns the value of serviceAccessReadOnly to the provider's read-only capability for service. If serviceAccessReadOnly is true, it implies service is read-only.

Parameters
service

The service for which we are setting the read-only capability. Possible values are listed in the Service::Type enumeration.

serviceAccessReadOnly

The value to set.

Since:

BlackBerry 10.0.0

void setServiceSupported (

Set function for support capability of service.

Assigns the value of serviceSupported to the provider's support capability for service. If serviceSupported is true, it implies service is supported.

Parameters
service

The service for which we are setting the support capability. Possible values are listed in the Service::Type enumeration.

serviceSupported

The value to set.

Since:

BlackBerry 10.0.0

void setSocial (
  • boolsocial)

Set function for Provider object's social property.

Assigns the value of social to the Provider object's social property.

Parameters
social

The value to set.

Since:

BlackBerry 10.0.0

void setValid (
  • boolvalid)

Set function for Provider object's state of correctness.

Assigns the value of valid to the object's state of correctness.

Parameters
valid

The value to set.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus