net.rim.blackberry.events.PushServiceErrorEvent

PushServiceErrorEvent

Methods | Constants


Packagenet.rim.blackberry.events
Classpublic class PushServiceErrorEvent
InheritancePushServiceErrorEvent Inheritance flash.events.ErrorEvent

An error event when a Push Service operation has failed. Use the errorID field retrieve the error code and use the text field to retrieve a textual description of the error (if available).

Please refer to the constants in this class for a list of possible error codes that can be returned and what operations they apply to.



Class information:
BlackBerry 10 Version: 10.0.0
Found in:  BlackBerryPushService.ane

See also

net.rim.blackberry.push.PushService



Public Methods

 MethodDefined By
  
PushServiceErrorEvent(type:String, text:String, id:int = 0)
Creates a Push Service error event.
PushServiceErrorEvent
  
clone():Event
[override]
PushServiceErrorEvent
  
toString():String
[override]
PushServiceErrorEvent

Public Constants

 ConstantDefined By
  CHANNEL_ALREADY_DESTROYED : int = 10004
[static] Error code when attempting to call destroy channel again after a successful destroy channel has already been done.
PushServiceErrorEvent
  CHANNEL_ALREADY_DESTROYED_BY_PROVIDER : int = 10005
[static] Error code when attempting to call destroy channel after a content provider has already done the destroying of the channel by unregistering a user.
PushServiceErrorEvent
  CHANNEL_SUSPENDED_BY_PROVIDER : int = 10012
[static] Error code when attempting to call destroy channel after a content provider has manually suspended a user.
PushServiceErrorEvent
  CREATE_CHANNEL_ERROR : String = createChannelError
[static] Error type for when a create channel fails.
PushServiceErrorEvent
  CREATE_CHANNEL_NOT_DONE : int = 10106
[static] Error code when attempting to perform a destroy channel and a create channel has not been done beforehand.
PushServiceErrorEvent
  CREATE_SESSION_ERROR : String = createSessionError
[static] Error type for when a create session fails.
PushServiceErrorEvent
  CREATE_SESSION_NOT_DONE : int = 10100
[static] Error code when attempting to perform an operation and a create session has not been done beforehand.
PushServiceErrorEvent
  DESTROY_CHANNEL_ERROR : String = destroyChannelError
[static] Error type for when a destroy channel fails.
PushServiceErrorEvent
  EXPIRED_AUTHENTICATION_TOKEN_PROVIDED_TO_PPG : int = 10008
[static] Error code for when a create channel or destroy channel operation internally passes an expired authentication token to the PPG.
PushServiceErrorEvent
  INTERNAL_ERROR : int = 500
[static] Error code for an internal error.
PushServiceErrorEvent
  INVALID_AUTHENTICATION_TOKEN_PROVIDED_TO_PPG : int = 10009
[static] This error code should not typically be encountered.
PushServiceErrorEvent
  INVALID_DEVICE_PIN : int = 10001
[static] Error code for an invalid device PIN as determined by the PPG.
PushServiceErrorEvent
  INVALID_OS_VERSION_OR_DEVICE_MODEL_NUMBER : int = 10011
[static] Error code for when a device attempting to do a create channel has an invalid operating system version number or an invalid device model number.
PushServiceErrorEvent
  INVALID_PPG_SUBSCRIBER_STATE : int = 10006
[static] This error code should not typically be encountered.
PushServiceErrorEvent
  INVALID_PPG_URL : int = 10114
[static] Error code when an invalid PPG URL was specified.
PushServiceErrorEvent
  INVALID_PROVIDER_APPLICATION_ID : int = 10002
[static] Error code for an invalid provider application ID.
PushServiceErrorEvent
  MISSING_PORT_FROM_PPG : int = 10107
[static] Error code as a result of an issue on a create channel operation obtaining a port from the PPG.
PushServiceErrorEvent
  MISSING_PPG_URL : int = 10102
[static] Error code when attempting to perform a create channel and a PPG URL was missing.
PushServiceErrorEvent
  MISSING_SUBSCRIPTION_RETURN_CODE_FROM_PPG : int = 10108
[static] Error code as a result of an issue on a create channel operation obtaining a subscription return code from the PPG.
PushServiceErrorEvent
  OPERATION_NOT_SUPPORTED : int = 10105
[static] Error code when a certain operation is currently not supported.
PushServiceErrorEvent
  PPG_SERVER_ERROR : int = 10110
[static] Error code when the PPG returns a server error.
PushServiceErrorEvent
  PPG_SUBSCRIBER_LIMIT_REACHED : int = 10010
[static] Error code for when too many devices have already performed a create channel for the provider application ID.
PushServiceErrorEvent
  PPG_SUBSCRIBER_NOT_FOUND : int = 10007
[static] Error code for when a destroy channel operation fails because the subscriber could not be found on the PPG's end.
PushServiceErrorEvent
  PUSH_SERVICE_CONNECTION_CLOSED : int = 501
[static] This result error code should not typically be encountered.
PushServiceErrorEvent
  PUSH_SERVICE_CONNECTION_PERMISSION_ERROR : int = 502
[static] Result error code when your application does not have the required permissions to connect to the underlying Push Service agent.
PushServiceErrorEvent
  PUSH_TRANSPORT_UNAVAILABLE : int = 10103
[static] Error code when a create channel or destroy channel operation has failed due to network issues or the push transport being down.
PushServiceErrorEvent
  REGISTER_TO_LAUNCH_ERROR : String = registerToLaunchError
[static] Error type for when a register to launch fails.
PushServiceErrorEvent
  SESSION_ALREADY_EXISTS : int = 10112
[static] Error code when an underlying session already exists.
PushServiceErrorEvent
  UNREGISTER_FROM_LAUNCH_ERROR : String = unregisterFromLaunchError
[static] Error type for when an unregister from launch fails.
PushServiceErrorEvent

Constructor Detail

PushServiceErrorEvent()


public function PushServiceErrorEvent(type:String, text:String, id:int = 0)

Creates a Push Service error event.

Parameters

type:String — The type of the event. See the list of constants in this class for the available types.
text:String — Text to be displayed as an error message. Event listeners can access this information through the text property.
id:int (default = 0) — A reference number to associate with the specific error.

Method Detail

clone()


override public function clone():Event

Returns

Event

toString()


override public function toString():String

Returns

String

Constant Detail

CHANNEL_ALREADY_DESTROYED


public static const CHANNEL_ALREADY_DESTROYED:int = 10004

Error code when attempting to call destroy channel again after a successful destroy channel has already been done.

Operations this error can occur on: Destroy Channel (only if using public/BIS PPG)

Recommended action: Most applications will typically want to just ignore this error code when it comes back.

CHANNEL_ALREADY_DESTROYED_BY_PROVIDER


public static const CHANNEL_ALREADY_DESTROYED_BY_PROVIDER:int = 10005

Error code when attempting to call destroy channel after a content provider has already done the destroying of the channel by unregistering a user.

Operations this error can occur on: Destroy Channel (only if using public/BIS PPG)

Recommended action: Most applications will typically want to just ignore this error code when it comes back.

CHANNEL_SUSPENDED_BY_PROVIDER


public static const CHANNEL_SUSPENDED_BY_PROVIDER:int = 10012

Error code when attempting to call destroy channel after a content provider has manually suspended a user. Similar to the CHANNEL_ALREADY_DESTROYED_BY_PROVIDER error.

Operations this error can occur on: Destroy Channel (only if using public/BIS PPG)

Recommended action: Most applications will typically want to just ignore this error code when it comes back.

CREATE_CHANNEL_ERROR


public static const CREATE_CHANNEL_ERROR:String = createChannelError

Error type for when a create channel fails.

CREATE_CHANNEL_NOT_DONE


public static const CREATE_CHANNEL_NOT_DONE:int = 10106

Error code when attempting to perform a destroy channel and a create channel has not been done beforehand.

Operations this error can occur on: Destroy Channel

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

CREATE_SESSION_ERROR


public static const CREATE_SESSION_ERROR:String = createSessionError

Error type for when a create session fails.

CREATE_SESSION_NOT_DONE


public static const CREATE_SESSION_NOT_DONE:int = 10100

Error code when attempting to perform an operation and a create session has not been done beforehand.

Operations this error can occur on: Create Channel, Destroy Channel, Register to Launch, Unregister from Launch

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

DESTROY_CHANNEL_ERROR


public static const DESTROY_CHANNEL_ERROR:String = destroyChannelError

Error type for when a destroy channel fails.

EXPIRED_AUTHENTICATION_TOKEN_PROVIDED_TO_PPG


public static const EXPIRED_AUTHENTICATION_TOKEN_PROVIDED_TO_PPG:int = 10008

Error code for when a create channel or destroy channel operation internally passes an expired authentication token to the PPG.

Operations this error can occur on: Create Channel, Destroy Channel (only if using public/BIS PPG)

Recommended action: Retrying the operation might correct the issue.

INTERNAL_ERROR


public static const INTERNAL_ERROR:int = 500

Error code for an internal error.

Operations this error can occur on: Create Session, Create Channel, Destroy Channel, Register to Launch, Unregister from Launch

Recommended action: Retrying the operation might correct the issue.

INVALID_AUTHENTICATION_TOKEN_PROVIDED_TO_PPG


public static const INVALID_AUTHENTICATION_TOKEN_PROVIDED_TO_PPG:int = 10009

This error code should not typically be encountered. It would only occur if a create channel or destroy channel operation internally passes an invalid authentication token to the PPG.

Operations this error can occur on: Create Channel, Destroy Channel (only if using public/BIS PPG)

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

INVALID_DEVICE_PIN


public static const INVALID_DEVICE_PIN:int = 10001

Error code for an invalid device PIN as determined by the PPG.

Operations this error can occur on: Create Channel, Destroy Channel (only if using public/BIS PPG)

Recommended action: Retrying the operation might correct the issue. The PIN is obtained under the covers by the public/BIS PPG. It very rarely has issues obtaining the device PIN, so a retry might fix this.

INVALID_OS_VERSION_OR_DEVICE_MODEL_NUMBER


public static const INVALID_OS_VERSION_OR_DEVICE_MODEL_NUMBER:int = 10011

Error code for when a device attempting to do a create channel has an invalid operating system version number or an invalid device model number.

Operations this error can occur on: Create Channel (only if using public/BIS PPG)

Recommended action: Retrying the operation is not recommended since this is an unrecoverable error that is out of control of the application. It might make sense to communicate this issue up to the user.

INVALID_PPG_SUBSCRIBER_STATE


public static const INVALID_PPG_SUBSCRIBER_STATE:int = 10006

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.

Operations this error can occur on: Create Channel, Destroy Channel (only if using public/BIS PPG)

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

INVALID_PPG_URL


public static const INVALID_PPG_URL:int = 10114

Error code when an invalid PPG URL was specified.

Operations this error can occur on: Create Channel, Destroy Channel (only if using public/BIS PPG)

Recommended action: Fixing the PPG URL programmatically and retrying might correct the issue. The PPG URL is passed in to the createChannel function of the PushService class.

INVALID_PROVIDER_APPLICATION_ID


public static const INVALID_PROVIDER_APPLICATION_ID:int = 10002

Error code for an invalid provider application ID.

Operations this error can occur on: Create Channel, Destroy Channel (only if using public/BIS PPG)

Recommended action: Fixing the application ID programmatically and retrying might correct the issue. The provider application ID is passed in to the PushService constructor.

MISSING_PORT_FROM_PPG


public static const MISSING_PORT_FROM_PPG:int = 10107

Error code as a result of an issue on a create channel operation obtaining a port from the PPG.

Operations this error can occur on: Create Channel

Recommended action: Retrying the operation might correct the issue.

MISSING_PPG_URL


public static const MISSING_PPG_URL:int = 10102

Error code when attempting to perform a create channel and a PPG URL was missing.

Operations this error can occur on: Create Channel (only if using public/BIS PPG)

Recommended action: Specifying a value for ppgUrl programmatically and retrying might correct the issue.

MISSING_SUBSCRIPTION_RETURN_CODE_FROM_PPG


public static const MISSING_SUBSCRIPTION_RETURN_CODE_FROM_PPG:int = 10108

Error code as a result of an issue on a create channel operation obtaining a subscription return code from the PPG.

Operations this error can occur on: Create Channel (only if using public/BIS PPG)

Recommended action: Retrying the operation might correct the issue.

OPERATION_NOT_SUPPORTED


public static const OPERATION_NOT_SUPPORTED:int = 10105

Error code when a certain operation is currently not supported.

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

PPG_SERVER_ERROR


public static const PPG_SERVER_ERROR:int = 10110

Error code when the PPG returns a server error.

Operations this error can occur on: Create Channel, Destroy Channel (only if using public/BIS PPG)

Recommended action: Wait until the PushTransportReadyEvent event is received before retrying.

PPG_SUBSCRIBER_LIMIT_REACHED


public static const PPG_SUBSCRIBER_LIMIT_REACHED:int = 10010

Error code for when too many devices have already performed a create channel for the provider application ID. (A create channel will effectively register a user with the PPG for public/BIS.)

Operations this error can occur on: Create Channel (only if using public/BIS PPG)

Recommended action: No action can be taken by the application for this error, but it should somehow be communicated back to the content provider and then to RIM to try to increase the allowed subscription limit.

PPG_SUBSCRIBER_NOT_FOUND


public static const PPG_SUBSCRIBER_NOT_FOUND:int = 10007

Error code for when a destroy channel operation fails because the subscriber could not be found on the PPG's end.

Operations this error can occur on: Destroy Channel (only if using public/BIS PPG)

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

PUSH_SERVICE_CONNECTION_CLOSED


public static const PUSH_SERVICE_CONNECTION_CLOSED:int = 501

Since : 10.1.0

This result error code should not typically be encountered. It would only occur if the underlying connection to the Push Service agent has been lost (i.e. closed).

Operations this error can occur on: Create Session, Create Channel, Destroy Channel, Register to Launch, Unregister from Launch

Recommended action: Wait until the PushServiceConnectionReadyEvent event is received before retrying your last operation.

PUSH_SERVICE_CONNECTION_PERMISSION_ERROR


public static const PUSH_SERVICE_CONNECTION_PERMISSION_ERROR:int = 502

Since : 10.1.0

Result error code when your application does not have the required permissions to connect to the underlying Push Service agent.

Operations this error can occur on: Create Session, Create Channel, Destroy Channel, Register to Launch, Unregister from Launch

Recommended action: If writing a consumer (public) application, make sure you specify the _sys_use_consumer_push system permission in your bar-descriptor.xml. If writing an enterprise application, make sure your application is installed in the Work perimeter.

PUSH_TRANSPORT_UNAVAILABLE


public static const PUSH_TRANSPORT_UNAVAILABLE:int = 10103

Error code when a create channel or destroy channel operation has failed due to network issues or the push transport being down.

Operations this error can occur on: Create Channel, Destroy Channel (only if using public/BIS PPG)

Recommended action: Wait until the PushTransportReadyEvent event is received before retrying. 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 up to the user to double check their wireless connection.

REGISTER_TO_LAUNCH_ERROR


public static const REGISTER_TO_LAUNCH_ERROR:String = registerToLaunchError

Error type for when a register to launch fails.

SESSION_ALREADY_EXISTS


public static const SESSION_ALREADY_EXISTS:int = 10112

Error code when an underlying session already exists.

Operations this error can occur on: Create Session

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

UNREGISTER_FROM_LAUNCH_ERROR


public static const UNREGISTER_FROM_LAUNCH_ERROR:String = unregisterFromLaunchError

Error type for when an unregister from launch fails.





comments powered by Disqus