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

Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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 the APNs channel was enabled.

Returns:

  • (String)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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 that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

Returns:

  • (String)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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

Specifies whether the APNs channel is enabled for the application.

Returns:

  • (Boolean)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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) This property is retained only for backward compatibility.

Returns:

  • (Boolean)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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

Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

Returns:

  • (Boolean)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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 APNs channel. This property is retained only for backward compatibility.

Returns:

  • (String)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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

Specifies whether the APNs channel is archived.

Returns:

  • (Boolean)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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 modified the APNs channel.

Returns:

  • (String)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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 the APNs channel was last modified.

Returns:

  • (String)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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 type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

Returns:

  • (String)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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 current version of the APNs channel.

Returns:

  • (Integer)


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 389

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