Class: Aws::Pinpoint::Types::GCMChannelResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Provides information about the status and settings of the GCM channel for an application. The GCM 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

#application_id ⇒ String

The unique identifier for the application that the GCM channel applies to.

Returns:

  • (String) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ String

The date and time when the GCM channel was enabled.

Returns:

  • (String) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#credential ⇒ 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) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  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) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

Specifies whether the GCM channel is enabled for the application.

Returns:

  • (Boolean) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#has_credential ⇒ Boolean

(Not used) This property is retained only for backward compatibility.

Returns:

  • (Boolean) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#has_fcm_service_credentials ⇒ Boolean

Returns true if the JSON file provided by Google during registration process was used in the ServiceJson field of the request.

Returns:

  • (Boolean) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

Returns:

  • (String) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#is_archived ⇒ Boolean

Specifies whether the GCM channel is archived.

Returns:

  • (Boolean) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_by ⇒ String

The user who last modified the GCM channel.

Returns:

  • (String) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ String

The date and time when the GCM channel was last modified.

Returns:

  • (String) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ String

The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

Returns:

  • (String) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ Integer

The current version of the GCM channel.

Returns:

  • (Integer) 


5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5789

class GCMChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :credential,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_fcm_service_credentials,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  SENSITIVE = []
  include Aws::Structure
end