gcm_get_result_error_code

March 26, 2020 Contributors

Name

gcm_get_result_error_code — Get the error code from the response results error

Synopsis

#include "modules/mobility/gcm.h"

| int **gcm_get_result_error_code** ( | error); |   |

const char * <var class="pdparam">error</var>;

Description

**Configuration Change. ** This function is available as of Momentum version 3.5.5.

In the context of a Google push notification, get the error code from a response results error. If you need to determine the delivery method use ec_message_get_delivery_method.

Parameters

error

A character pointer to the GCM response error.

Return Values

This function returns one of the following values:

  • GCM_NO_ERROR

  • GCM_UNAVAILABLE

  • GCM_MISSING_REGISTRATION

  • GCM_INVALID_REGISTRATION

  • GCM_MISMATCH_SENDER_ID

  • GCM_NOT_REGISTERED

  • GCM_MESSAGE_TOO_BIG

  • GCM_INVALID_DATA_KEY

  • GCM_INVALID_TTL

  • GCM_INTERNAL_SERVER_ERROR

  • GCM_INVALID_PACKAGE_NAME

  • GCM_UNKNOWN

Threading

It is legal to call this function in any thread.

See Also

Momentum for Mobile Push Notifications, Hooks in the gcm Scope and gcm_classify_error