|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.android.gcm.server.Result
public final class Result
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:
- CallgetMessageId()
: - null means error, callgetErrorCodeName()
- non-null means the message was created: - CallgetCanonicalRegistrationId()
- if it returns null, do nothing. - otherwise, update the server datastore with the new id.
Method Summary | |
---|---|
java.lang.String |
getCanonicalRegistrationId()
Gets the canonical registration id, if any. |
java.lang.String |
getErrorCodeName()
Gets the error code, if any. |
java.lang.String |
getMessageId()
Gets the message id, if any. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public java.lang.String getMessageId()
public java.lang.String getCanonicalRegistrationId()
public java.lang.String getErrorCodeName()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |