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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


5714
5715
5716
5717
5718
5719
5720
5721
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5714

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) 


5714
5715
5716
5717
5718
5719
5720
5721
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5714

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) 


5714
5715
5716
5717
5718
5719
5720
5721
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5714

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.

Returns:

  • (String) 


5714
5715
5716
5717
5718
5719
5720
5721
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5714

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