net.rim.pushsdk.push
Class FailedPushResult

java.lang.Object
  extended by net.rim.pushsdk.push.FailedPushResult

public class FailedPushResult
extends Object

The result of an attempt to push to a subscriber that failed due to an error on the PPG end. (e.g. the PPG could not be contacted, a duplicate push ID was found, etc.)

IMPORTANT NOTE: This class does NOT represent results for subscribers that the PPG has attempted to deliver to, but were unsuccessful. For a push application with a service level of Push Plus, use result notification to determine the final outcome of a push to a subscriber. Or, use the status query methods, if not using result notification / acknowledgements. The final outcome of a push to a subscriber cannot be determined for a push application with a service level of Push Essentials.

Since:
1.1
Author:
mdandrea

Constructor Summary
FailedPushResult(String subscriberId, StatusCode code, String description)
          Constructs a failed push result.
 
Method Summary
 StatusCode getCode()
          Gets the code associated with the failed push attempt.
 String getDescription()
          Gets the textual description associated with the failed push attempt.
 String getSubscriberId()
          Gets the id of the subscriber that was attempted to be pushed to (but failed).
 String toString()
          Constructs a String with all attributes in name = value format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FailedPushResult

public FailedPushResult(String subscriberId,
                        StatusCode code,
                        String description)
Constructs a failed push result.

Parameters:
subscriberId - the id of the subscriber that was attempted to be pushed to
code - the failure code
description - a textual description of the failure code
Method Detail

getSubscriberId

public String getSubscriberId()
Gets the id of the subscriber that was attempted to be pushed to (but failed).

Returns:
the subscriber id

getCode

public StatusCode getCode()
Gets the code associated with the failed push attempt.

Returns:
the failure code

getDescription

public String getDescription()
Gets the textual description associated with the failed push attempt.

Returns:
a textual description of the failure code

toString

public String toString()
Constructs a String with all attributes in name = value format.

Overrides:
toString in class Object
Returns:
a String representation of this object.


Copyright © 2011 Research In Motion. All Rights Reserved.