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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #default_authentication_method ⇒ String

  The default authentication method used for GCM.

• #enabled ⇒ Boolean

  Specifies whether to enable the GCM channel for the application.

• #service_json ⇒ String

  The contents of the JSON file provided by Google during registration in order to generate an access token for authentication.

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)

# File 'lib/aws-sdk-pinpoint/types.rb', line 5737

class GCMChannelRequest < Struct.new(
  :api_key,
  :default_authentication_method,
  :enabled,
  :service_json)
  SENSITIVE = []
  include Aws::Structure
end

#default_authentication_method ⇒ String

The default authentication method used for GCM. Values are either “TOKEN” or “KEY”. Defaults to “KEY”.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 5737

class GCMChannelRequest < Struct.new(
  :api_key,
  :default_authentication_method,
  :enabled,
  :service_json)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

Specifies whether to enable the GCM channel for the application.

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 5737

class GCMChannelRequest < Struct.new(
  :api_key,
  :default_authentication_method,
  :enabled,
  :service_json)
  SENSITIVE = []
  include Aws::Structure
end

#service_json ⇒ 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].

[1]: firebase.google.com/docs/cloud-messaging/migrate-v1

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 5737

class GCMChannelRequest < Struct.new(
  :api_key,
  :default_authentication_method,
  :enabled,
  :service_json)
  SENSITIVE = []
  include Aws::Structure
end