PushErrorCode

Since: BlackBerry 10.0.0

#include <bb/network/PushErrorCode>

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

Encapsulates the result codes that occur during a PushService operation.


Overview

Public Types

Type

The result codes that occur from a PushService operation.

Since:

BlackBerry 10.0.0

NoError = 0

Indicates a success.

InternalError = 500

Indicates an internal error.

This result code can occur from any of the following PushService operations: createSession(), createChannel(), destroyChannel(), registerToLaunch(), and unregisterFromLaunch().

Recommended action: When you receive this code, it's usually recommended that you try the operation again.

Since:

BlackBerry 10.0.0

ConnectionClosed = 501

Indicates the connection to the Push Agent has been closed.

This result code can occur from any of the following PushService operations: createSession(), createChannel(), destroyChannel(), registerToLaunch(), and unregisterFromLaunch().

Recommended action: This result code will trigger the connectionClosed signal. After receiving the connectionClosed signal, the application should re-establish the connection with the Push Agent, and then retry the operation once the connection has been reestablished. See connectionClosed.

Since:

BlackBerry 10.2.0

NoPermCreateConnection = 502

Indicates the application does not have the required permission to connect with the Push Agent.

This result code can occur from any of the following PushService operations: createSession(), createChannel(), destroyChannel(), registerToLaunch(), and unregisterFromLaunch().

Recommended action: If you are writing a consumer application for the general public, make sure you specify the following permission tag in your bar-descriptor.xml file:

<permission system="true">_sys_use_consumer_push</permission>
If you are writing an enterprise application, make sure your application is installed in the Work perimeter.
Since:

BlackBerry 10.2.0

InvalidPin = 10001

Indicates an invalid device PIN as determined by the PPG.

This result code can occur from any of the following PushService operations: createChannel() and destroyChannel() (only if using public/BIS PPG).

Recommended action: When you receive this code, it might be useful to communicate the issue to the user through an alert message. Retrying the operation might not be helpful since it's most likely an unrecoverable error that is beyond the control of the application.

Since:

BlackBerry 10.0.0

InvalidProviderId = 10002

Indicates an invalid provider application ID.

This result code can occur from any of the following PushService operations: createSession(), createChannel(), destroyChannel() (only if using public/BIS PPG).

Recommended action: When you receive this code, fixing the application ID programmatically and retrying might correct the issue. The provider application ID is passed in to the PushService constructor.

Since:

BlackBerry 10.0.0

UserAlreadyUnregistered = 10004

Indicates that a successful destroy channel has already been done.

This result code can occur from the following PushService operation: destroyChannel() (only if using public/BIS PPG).

Recommended action: This result code is for your information only. Most applications can probably ignore this code altogether.

Since:

BlackBerry 10.0.0

AlreadyUnsubscribedByProvider = 10005

Indicates that the content provider has already unsubscribed the user.

This result code can occur from any of the following PushService operations: destroyChannel() (only if using public/BIS PPG).

Recommended action: This result code is for your information only. Most applications can probably ignore this code altogether.

Since:

BlackBerry 10.0.0

InvalidSubscriptionStatus = 10006

Indicates that the subscriber on the PPG is in an invalid state.

This result code can occur from any of the following PushService operations: createChannel() and destroyChannel() (only if using public/BIS PPG). However, this error code should not typically be encountered. It would only occur if a create or destroy channel operation internally causes the state of a subscriber on the PPG to be in an invalid state.

Note:

Recommended action: If this code occurs, it should be logged and reported to the RIM support team.

Since:

BlackBerry 10.0.0

PinNotFound = 10007

Indicates that a destroy channel operation failed because the subscriber could not be found on the PPG.

This result code can occur from any of the following PushService operations: destroyChannel() (only if using public/BIS PPG).

Recommended action: This code can most likely be ignored. If the subscriber could not be found on the PPG, then destroying the channel will have no effect anyway (it is as if they were never registered with the PPG using createchannel() ).

Since:

BlackBerry 10.0.0

SubscriptionRequestTimeOut = 10008

Indicates that a create channel or destroy channel operation passed an expired authentication token to the PPG.

This result code can occur from any of the following PushService operations: createChannel() and destroyChannel() (only if using public/BIS PPG).

Recommended action: If this code occurs, retrying the operation might correct the issue.

Since:

BlackBerry 10.0.0

InvalidAccess = 10009

Indicates that a create channel or destroy channel operation passed an invalid authentication token to the PPG.

This result code can occur from any of the following PushService operations: createChannel() and destroyChannel() (only if using public/BIS PPG). However, it is very unlikely that you will encounter this result code.

Note:

Recommended action: If this code occurs, it should be logged and reported to the RIM support team.

Since:

BlackBerry 10.0.0

SubscriptionLimitExceeded = 10010

Indicates that too many devices have already performed a create channel request for the provider application ID.

This result code can occur from any of the following PushService operations: createChannel() (only if using public/BIS PPG).

Note:

Recommended action: This result code should be communicated back to the content provider and then to RIM to try to increase the allowed subscription limit.

Since:

BlackBerry 10.0.0

InvalidSubscriptionParameters = 10011

Indicates that the application attempting to create a channel is sending an invalid operating system version number or an invalid device model number.

This result code can occur from any of the following PushService operations: createChannel() (only if using public/BIS PPG).

Recommended action: When you receive this code, it might be useful to communicate the issue to the user through an alert message. Retrying the operation is not recommended since this is an unrecoverable error that is beyond the control of the application.

Since:

BlackBerry 10.0.0

SubscriptionAlreadySuspendedByProvider = 10012

Indicates that a content provider has manually suspended a user already.

This code is similar to the AlreadyUnsubscribedByProvider error.

This result code can occur from any of the following PushService operations: destroyChannel() (only if using public/BIS PPG).

Recommended action: Most applications can ignore this result code.

Since:

BlackBerry 10.0.0

SessionNotFound = 10100

Indicates that a create session operation must be performed before attempting this operation.

This result code can occur from any of the following PushService operations: createChannel(), destroyChannel(), registerToLaunch(), and unregisterFromLaunch().

Recommended action: This usually means a programming error in the application.

Since:

BlackBerry 10.0.0

PpgUrlMissing = 10102

Indicates that a PPG URL was not specified while attempting to perform a create channel operation.

This result code can occur from any of the following PushService operations: createChannel().

Recommended action: This usually means a programming error in the application. Make sure that a PPG URL is specified when performing a Create Channel operation.

Since:

BlackBerry 10.0.0

TransportFailure = 10103

Indicates a failed create channel or destroy channel operation due to a push transport failure.

This result code can occur from any of the following PushService operations: createChannel() and destroyChannel() (only if using public/BIS PPG).

Recommended action: After receiving the pushTransportReady() signal, retry the operation. This error can also occur when the user's wireless connection (e.g. Wi-Fi, Mobile Network) is off or temporarily down, so it might make sense to communicate this issue to the user.

Since:

BlackBerry 10.0.0

InvalidCommand = 10104

Indicates that an invalid message was written to the push service file descriptor.

This result code can occur from a custom write operation to the push service file descriptor.

Recommended action: This usually means a programming error in the application. Instead of writing to the push service file descriptor directly, it is recommended to use the PushService object.

Since:

BlackBerry 10.0.0

CommandNotSupported = 10105

Indicates that a certain operation is currently not supported.

Recommended action: This operation/feature might not yet be implemented and so should not be performed.

Since:

BlackBerry 10.0.0

UserNotRegistered = 10106

Indicates that the destroy channel operation is invalid because a create channel operation was not performed before.

This result code can occur from any of the following PushService operations: destroyChannel()

Recommended action: This might mean a programming error in the application.

Since:

BlackBerry 10.0.0

SubscribeMissingPort = 10107

Indicates an issue with obtaining a port from the PPG in a create channel operation.

This result code can occur from any of the following PushService operations: createChannel().

Recommended action: Retrying the operation might correct the issue.

Since:

BlackBerry 10.0.0

SubscribeMissingRc = 10108

Indicates an issue with obtaining a subscription return code from the PPG during a create channel operation.

This result code can occur from any of the following PushService operations: createChannel() (only if using public/BIS PPG).

Recommended action: Retrying the operation might correct the issue.

Since:

BlackBerry 10.0.0

SubscriptionContentNotAvailable = 10110

Indicates that the create channel or destroy channel operation failed due to a failure to communicate with the PPG.

This result code can occur from any of the following PushService operations: createChannel() and destroyChannel() (only if using public/BIS PPG)

Recommended action: After receiving the pushTransportReady() signal, retry the operation.

Since:

BlackBerry 10.0.0

InvalidTargetKey = 10111

Indicates that the invocation target key is invalid.

This result code can occur from any of the following PushService operations: createSession().

Recommended action: Fixing the invocation target key programmatically and retrying might correct the issue. The invocation target key is passed in to the PushService constructor.

Since:

BlackBerry 10.0.0

SessionAlreadyExists = 10112

Indicates that a session already exists.

This result code can occur from any of the following PushService operations: createSession().

Recommended action: Check the application provider ID and target key to ensure that they are valid and unique.

Since:

BlackBerry 10.0.0

InvalidPpgUrl = 10114

Indicates a failed create channel or destroy channel operation due to an invalid PPG URL.

This result code can occur from any of the following PushService operations: createChannel() and destroyChannel() (only if using public/BIS PPG).

Recommended action: Check that the PPG URL is valid.

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