IdentityService

Since: IdsServiceResult::Success if successful.

#include <bb/platform/identity/IdentityService>

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

The Identity Service is used for library level functions that define behavior of the API, and apply to all providers created by an application.


Overview

Properties Index

intversion [read-only]

Public Functions Index

IdentityService (QObject *parent=0)
virtual ~IdentityService ()

Static Public Functions Index

Q_INVOKABLE bb::platform::identity::IdentityServiceResult::TypesetGuiAllowed (bool allowed)
Q_INVOKABLE bb::platform::identity::IdentityServiceResult::TypesetLogVerbosity (bb::platform::identity::IdentityServiceLogVerbosity::Type verbosity)
Q_INVOKABLE bb::platform::identity::IdentityServiceResult::TypesetWindowGroupId (const QString &groupId)
intversion ()

Properties

int version[read-only]

The version of the BlackBerry ID APIs that your application is using.

The version of the BlackBerry ID library using the following scheme: (Major * 1000000) + (Minor * 1000) + Patch

Public Functions

IdentityService (

Constructs an empty IdentityService instance and initializes the library for use.

Parameters
parent

The parent object. Setting parent to 0 constructs an IdentityService instance with no parent.

virtual~IdentityService ()

Destructor.

Static Public Functions

Q_INVOKABLE bb::platform::identity::IdentityServiceResult::Type setGuiAllowed (
  • boolallowed)

Allows an application to modify the default behavior of the APIs as well as configure how the library and application are integrated.

Parameters
allowed

False to suppress GUI interaction that may appear as a result of API calls.

Return:

IdsServiceResult::Success if successful.

Errors The info field of the resulting IdsResult will contain an errno value of:
  • EFAULT: Library has not been initialized.

  • EINVAL: An invalid parameter was passed to the function.

  • ENOMEM: Not enough memory to store the setting.

Q_INVOKABLE bb::platform::identity::IdentityServiceResult::Type setLogVerbosity (

Allows an application to modify the default behavior of the APIs as well as configure how the library and application are integrated.

By default, the log verbosity will be normal.

Parameters
verbosity

The desired logging verbosity.

Return:

IdsServiceResult::Success if successful.

Errors The info field of the resulting IdsResult will contain an errno value of:
  • EFAULT: Library has not been initialized.

  • EINVAL: An invalid parameter was passed to the function.

  • ENOMEM: Not enough memory to store the setting.

Q_INVOKABLE bb::platform::identity::IdentityServiceResult::Type setWindowGroupId (

Allows application's to modify the default behavior of the APIs as well as configure how the library and application are integrated.

Parameters
groupId

The calling applications group id.

Return:

IdsServiceResult::Success if successful.

Errors The info field of the resulting IdsResult will contain an errno value of:
  • EFAULT: Library has not been initialized.

  • EINVAL: An invalid parameter was passed to the function.

  • ENOMEM: Not enough memory to store the setting.

int version ()

Retrieves the version of the BlackBerry ID APIs that your application is using.

Return:

The version of the BlackBerry ID library using the following scheme: (Major * 1000000) + (Minor * 1000) + Patch

Last modified: 2014-09-30



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

comments powered by Disqus