public final class

Result

extends Object
implements Serializable
java.lang.Object
   ↳ com.google.android.gcm.server.Result

Class Overview

Result of a GCM message request that returned HTTP status code 200.

If the message is successfully created, the getMessageId() returns the message id and getErrorCodeName() returns null; otherwise, getMessageId() returns null and getErrorCodeName() returns the code of the error.

There are cases when a request is accept and the message successfully created, but GCM has a canonical registration id for that device. In this case, the server should update the registration id to avoid rejected requests in the future.

In a nutshell, the workflow to handle a result is:

   - Call getMessageId():
     - null means error, call getErrorCodeName()
     - non-null means the message was created:
       - Call getCanonicalRegistrationId()
         - if it returns null, do nothing.
         - otherwise, update the server datastore with the new id.
 

Summary

Public Methods
String getCanonicalRegistrationId()
Gets the canonical registration id, if any.
String getErrorCodeName()
Gets the error code, if any.
String getMessageId()
Gets the message id, if any.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public String getCanonicalRegistrationId ()

Gets the canonical registration id, if any.

public String getErrorCodeName ()

Gets the error code, if any.

public String getMessageId ()

Gets the message id, if any.

public String toString ()

No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.