You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::GCMChannelRequest

Inherits:

Struct

Object
Struct
Aws::Pinpoint::Types::GCMChannelRequest

show all

Defined in:: (unknown)

Overview

Note:

When passing GCMChannelRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  api_key: "__string", # required
  enabled: false,
}

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.

Returned by:

UpdateGcmChannelRequest#gcm_channel_request

Instance Attribute Summary collapse

#api_key ⇒ 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.
#enabled ⇒ Boolean
Specifies whether to enable the GCM channel for the application.

Instance Attribute Details

#api_key ⇒ `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.

Returns:

(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.

#enabled ⇒ `Boolean`

Specifies whether to enable the GCM channel for the application.