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

Class: Aws::Pinpoint::Types::APNSVoipChannelResponse

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::APNSVoipChannelResponse

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) VoIP channel for an application.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #application_id ⇒ String

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

• #creation_date ⇒ String

  The date and time when the APNs VoIP channel was enabled.

• #default_authentication_method ⇒ String

  The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

• #enabled ⇒ Boolean

  Specifies whether the APNs VoIP channel is enabled for the application.

• #has_credential ⇒ Boolean

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

• #has_token_key ⇒ Boolean

  Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens.

• #id ⇒ String

  (Deprecated) An identifier for the APNs VoIP channel.

• #is_archived ⇒ Boolean

  Specifies whether the APNs VoIP channel is archived.

• #last_modified_by ⇒ String

  The user who last modified the APNs VoIP channel.

• #last_modified_date ⇒ String

  The date and time when the APNs VoIP channel was last modified.

• #platform ⇒ String

  The type of messaging or notification platform for the channel.

• #version ⇒ Integer

  The current version of the APNs VoIP channel.

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

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

class APNSVoipChannelResponse < 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_date ⇒ String

The date and time when the APNs VoIP channel was enabled.

Returns:

• (String)

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

class APNSVoipChannelResponse < 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_method ⇒ String

The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

Returns:

• (String)

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

class APNSVoipChannelResponse < 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

#enabled ⇒ Boolean

Specifies whether the APNs VoIP channel is enabled for the application.

Returns:

• (Boolean)

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

class APNSVoipChannelResponse < 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_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 873

class APNSVoipChannelResponse < 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_key ⇒ Boolean

Specifies whether the APNs VoIP 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)

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

class APNSVoipChannelResponse < 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

#id ⇒ String

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

Returns:

• (String)

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

class APNSVoipChannelResponse < 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_archived ⇒ Boolean

Specifies whether the APNs VoIP channel is archived.

Returns:

• (Boolean)

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

class APNSVoipChannelResponse < 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_by ⇒ String

The user who last modified the APNs VoIP channel.

Returns:

• (String)

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

class APNSVoipChannelResponse < 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_date ⇒ String

The date and time when the APNs VoIP channel was last modified.

Returns:

• (String)

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

class APNSVoipChannelResponse < 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

#platform ⇒ String

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

Returns:

• (String)

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

class APNSVoipChannelResponse < 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

#version ⇒ Integer

The current version of the APNs VoIP channel.

Returns:

• (Integer)

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

class APNSVoipChannelResponse < 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