java.lang.Object
org.apache.fineract.infrastructure.gcm.domain.Result
All Implemented Interfaces:
Serializable

public final class Result extends Object implements Serializable
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 #getErrorCode() returns null; otherwise, #getMessageId() returns null and #getErrorCode() 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 #getErrorCode()
     - non-null means the message was created:
       - Call #getCanonicalRegistrationId()
         - if it returns null, do nothing.
         - otherwise, update the server datastore with the new id.
 
See Also: