AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)

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

#creation_dateString

The date and time when the APNs channel was enabled.

Returns:

  • (String)

    The date and time when the APNs channel was enabled.

#default_authentication_methodString

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

Returns:

  • (String)

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

#enabledBoolean

Specifies whether the APNs channel is enabled for the application.

Returns:

  • (Boolean)

    Specifies whether the APNs channel is enabled for the application.

#has_credentialBoolean

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

Returns:

  • (Boolean)

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

#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)

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

#idString

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

Returns:

  • (String)

    (Deprecated) An identifier for the APNs channel.

#is_archivedBoolean

Specifies whether the APNs channel is archived.

Returns:

  • (Boolean)

    Specifies whether the APNs channel is archived.

#last_modified_byString

The user who last modified the APNs channel.

Returns:

  • (String)

    The user who last modified the APNs channel.

#last_modified_dateString

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

Returns:

  • (String)

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

#platformString

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

Returns:

  • (String)

    The type of messaging or notification platform for the channel.

#versionInteger

The current version of the APNs channel.

Returns:

  • (Integer)

    The current version of the APNs channel.