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

Class: Aws::Pinpoint::Types::ADMChannelRequest

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

Overview

Note:

When making an API call, you may pass ADMChannelRequest data as a hash:

{
  client_id: "__string", # required
  client_secret: "__string", # required
  enabled: false,
}

Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

Instance Attribute Summary collapse

Instance Attribute Details

#client_idString

The Client ID that you received from Amazon to send messages by using ADM.

Returns:

  • (String)


39
40
41
42
43
44
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 39

class ADMChannelRequest < Struct.new(
  :client_id,
  :client_secret,
  :enabled)
  include Aws::Structure
end

#client_secretString

The Client Secret that you received from Amazon to send messages by using ADM.

Returns:

  • (String)


39
40
41
42
43
44
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 39

class ADMChannelRequest < Struct.new(
  :client_id,
  :client_secret,
  :enabled)
  include Aws::Structure
end

#enabledBoolean

Specifies whether to enable the ADM channel for the application.

Returns:

  • (Boolean)


39
40
41
42
43
44
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 39

class ADMChannelRequest < Struct.new(
  :client_id,
  :client_secret,
  :enabled)
  include Aws::Structure
end