/AWS1/CL_PPTGCMCHANNELREQUEST¶
Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_apikey TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
iv_defaultauthntctnmethod TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
iv_enabled TYPE /AWS1/PPT__BOOLEAN /AWS1/PPT__BOOLEAN¶
Specifies whether to enable the GCM channel for the application.
iv_servicejson TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see Migrate from legacy FCM APIs to HTTP v1.
Queryable Attributes¶
ApiKey¶
The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIKEY() |
Getter for APIKEY, with configurable default |
ASK_APIKEY() |
Getter for APIKEY w/ exceptions if field has no value |
HAS_APIKEY() |
Determine if APIKEY has a value |
DefaultAuthenticationMethod¶
The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTAUTHNTCTNMETHOD() |
Getter for DEFAULTAUTHENTICATIONMETHOD, with configurable de |
ASK_DEFAULTAUTHNTCTNMETHOD() |
Getter for DEFAULTAUTHENTICATIONMETHOD w/ exceptions if fiel |
HAS_DEFAULTAUTHNTCTNMETHOD() |
Determine if DEFAULTAUTHENTICATIONMETHOD has a value |
Enabled¶
Specifies whether to enable the GCM channel for the application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLED() |
Getter for ENABLED, with configurable default |
ASK_ENABLED() |
Getter for ENABLED w/ exceptions if field has no value |
HAS_ENABLED() |
Determine if ENABLED has a value |
ServiceJson¶
The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see Migrate from legacy FCM APIs to HTTP v1.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEJSON() |
Getter for SERVICEJSON, with configurable default |
ASK_SERVICEJSON() |
Getter for SERVICEJSON w/ exceptions if field has no value |
HAS_SERVICEJSON() |
Determine if SERVICEJSON has a value |