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

Inherits:

Struct

Object
Struct
Aws::Pinpoint::Types::GCMChannelResponse

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#application_id ⇒ String
The unique identifier for the application that the GCM channel applies to.
#creation_date ⇒ String
The date and time when the GCM channel was enabled.
#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.
#default_authentication_method ⇒ String
The default authentication method used for GCM.
#enabled ⇒ Boolean
Specifies whether the GCM channel is enabled for the application.
#has_credential ⇒ Boolean
(Not used) This property is retained only for backward compatibility.
#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.
#id ⇒ String
(Deprecated) An identifier for the GCM channel.
#is_archived ⇒ Boolean
Specifies whether the GCM channel is archived.
#last_modified_by ⇒ String
The user who last modified the GCM channel.
#last_modified_date ⇒ String
The date and time when the GCM channel was last modified.
#platform ⇒ String
The type of messaging or notification platform for the channel.
#version ⇒ Integer
The current version of the GCM channel.

Instance Attribute Details

#application_id ⇒ `String`

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

Returns:

(String)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

#creation_date ⇒ String

#credential ⇒ String

#default_authentication_method ⇒ String

#enabled ⇒ Boolean

#has_credential ⇒ Boolean

#has_fcm_service_credentials ⇒ Boolean

#id ⇒ String

#is_archived ⇒ Boolean

#last_modified_by ⇒ String

#last_modified_date ⇒ String

#platform ⇒ String

#version ⇒ Integer

#application_id ⇒ `String`

#creation_date ⇒ `String`

#credential ⇒ `String`

#default_authentication_method ⇒ `String`

#enabled ⇒ `Boolean`

#has_credential ⇒ `Boolean`

#has_fcm_service_credentials ⇒ `Boolean`

#id ⇒ `String`

#is_archived ⇒ `Boolean`

#last_modified_by ⇒ `String`

#last_modified_date ⇒ `String`

#platform ⇒ `String`

#version ⇒ `Integer`