ContactError

The ContactError object contains error codes and is returned in the contactError callback.

Supported Platform(s)

- BlackBerry 10

View Supported Platform Table

API	BB5.0	BB6.0	BB7.0	PB1.0	PB2.0	BB10	Ripple
code						Y
UNKNOWN_ERROR						Y
INVALID_ARGUMENT_ERROR						Y
TIMEOUT_ERROR						Y
PENDING_OPERATION_ERROR						Y
IO_ERROR						Y
NOT_SUPPORTED_ERROR						Y
PERMISSION_DENIED_ERROR						Y

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

You must declare the feature element(s) below in your configuration document:

Feature ID	BB5.0	BB6.0	BB7.0	PB1.0	PB2.0	BB10	Ripple
<feature id="blackberry.pim.contacts" />						Y

Permission Elements (PlayBook and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Properties

Number

code

Constants

Number	UNKNOWN_ERROR
Number	INVALID_ARGUMENT_ERROR
Number	TIMEOUT_ERROR
Number	PENDING_OPERATION_ERROR
Number	IO_ERROR
Number	NOT_SUPPORTED_ERROR
Number	PERMISSION_DENIED_ERROR

Properties

readonly Number code

A code specifying the type of error that occurred.

Supported Platforms
	- BlackBerry 10

Code Example:

function findContacts() {
    var contacts = blackberry.pim.contacts;
    contacts.find(["name"], null, onFindSuccess, onFindError);
}

function onFindSuccess(contacts) {
    alert("Contact find succeeded");
}

function onFindError(error) {
    switch (error.code) {
    case error.UNKNOWN_ERROR:
         alert("Contact find error: An unknown error occurred");
         break;
    case error.INVALID_ARGUMENT_ERROR:
         alert("Contact find error: Invalid argument");
         break;
    case error.PERMISSION_DENIED_ERROR:
         alert("Contact find error: Permission denied error");
         break;
    default:
         alert("Contact find error: other error, code=" + error.code);
    }
}

Constants

static Number UNKNOWN_ERROR = 0

An unknown error occurred.

Supported Platforms
	- BlackBerry 10

static Number INVALID_ARGUMENT_ERROR = 1

A parameter was incorrect.

Supported Platforms
	- BlackBerry 10

static Number TIMEOUT_ERROR = 2

The operation timed out.

Supported Platforms
	- BlackBerry 10

static Number PENDING_OPERATION_ERROR = 3

The operation failed because a previous operation is pending.

Supported Platforms
	- BlackBerry 10

static Number IO_ERROR = 4

An IO error occurred.

Supported Platforms
	- BlackBerry 10

static Number NOT_SUPPORTED_ERROR = 5

The operation is not supported.

Supported Platforms
	- BlackBerry 10

static Number PERMISSION_DENIED_ERROR = 20

The operation failed due to insufficient permissions.

Supported Platforms
	- BlackBerry 10

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:35 GMT-0500 (EST)