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

Class: Aws::Pinpoint::Types::APNSChannelResponse

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

Overview

Apple Distribution Push Notification Service channel definition.

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The ID of the application that the channel applies to.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#creation_dateString

The date and time when this channel was created.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#default_authentication_methodString

The default authentication method used for APNs.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#enabledBoolean

If the channel is enabled for sending messages.

Returns:

  • (Boolean)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#has_credentialBoolean

Not used. Retained for backwards compatibility.

Returns:

  • (Boolean)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#has_token_keyBoolean

Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.

Returns:

  • (Boolean)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#idString

(Deprecated) An identifier for the channel. Retained for backwards compatibility.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#is_archivedBoolean

Indicates whether or not the channel is archived.

Returns:

  • (Boolean)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#last_modified_byString

The user who last updated this channel.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#last_modified_dateString

The date and time when this channel was last modified.

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#platformString

The platform type. For this channel, the value is always "ADM."

Returns:

  • (String)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#versionInteger

The channel version.

Returns:

  • (Integer)


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 360

class APNSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end