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

Class: Aws::Pinpoint::Types::APNSVoipChannelRequest

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 APNSVoipChannelRequest data as a hash:

{
  bundle_id: "__string",
  certificate: "__string",
  default_authentication_method: "__string",
  enabled: false,
  private_key: "__string",
  team_id: "__string",
  token_key: "__string",
  token_key_id: "__string",
}

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idString

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

Returns:

  • (String)


800
801
802
803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 800

class APNSVoipChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#certificateString

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

Returns:

  • (String)


800
801
802
803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 800

class APNSVoipChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#default_authentication_methodString

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

Returns:

  • (String)


800
801
802
803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 800

class APNSVoipChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#enabledBoolean

Specifies whether to enable the APNs VoIP channel for the application.

Returns:

  • (Boolean)


800
801
802
803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 800

class APNSVoipChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#private_keyString

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

Returns:

  • (String)


800
801
802
803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 800

class APNSVoipChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#team_idString

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

Returns:

  • (String)


800
801
802
803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 800

class APNSVoipChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#token_keyString

The authentication key to use for APNs tokens.

Returns:

  • (String)


800
801
802
803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 800

class APNSVoipChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#token_key_idString

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

Returns:

  • (String)


800
801
802
803
804
805
806
807
808
809
810
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 800

class APNSVoipChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end