Public Member Functions | Properties

SNSSubscribeRequest Class Reference

Subscribe Request. More...

#import <SNSSubscribeRequest.h>

List of all members.

Public Member Functions

(id) - init
 Default constructor for a new SubscribeRequest object.
(id) - initWithTopicArn:andProtocol:andEndpoint:
 Constructs a new SubscribeRequest object.
(NSString *) - description
 Returns a string representation of this object; useful for testing and debugging.

Properties

NSString * topicArn
 The ARN of topic you want to subscribe to.
NSString * protocol
 The protocol you want to use.
NSString * endpoint
 The endpoint that you want to receive notifications.

Detailed Description

Subscribe Request.


Member Function Documentation

- (NSString* SNSSubscribeRequest.)description  

Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
- (id SNSSubscribeRequest.)init  

Default constructor for a new SubscribeRequest object.

Callers should use the property methods to initialize this object after creating it.

- (id SNSSubscribeRequest.)initWithTopicArn: (NSString *)  theTopicArn
andProtocol: (NSString *)  theProtocol
andEndpoint: (NSString *)  theEndpoint 

Constructs a new SubscribeRequest object.

Callers should use properties to initialize any additional object members.

Parameters:
theTopicArn The ARN of topic you want to subscribe to.
theProtocol The protocol you want to use. Supported protocols include:

  • http -- delivery of JSON-encoded message via HTTP POST
  • https -- delivery of JSON-encoded message via HTTPS POST
  • email -- delivery of message via SMTP
  • email-json -- delivery of JSON-encoded message via SMTP
  • sqs -- delivery of JSON-encoded message to an Amazon SQS queue
theEndpoint The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the endpoint is an URL beginning with "http://"
  • For the https protocol, the endpoint is a URL beginning with "https://"
  • For the email protocol, the endpoint is an e-mail address
  • For the email-json protocol, the endpoint is an e-mail address
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue

Property Documentation

- (NSString *) endpoint [read, write, retain]

The endpoint that you want to receive notifications.

Endpoints vary by protocol:

  • For the http protocol, the endpoint is an URL beginning with "http://"
  • For the https protocol, the endpoint is a URL beginning with "https://"
  • For the email protocol, the endpoint is an e-mail address
  • For the email-json protocol, the endpoint is an e-mail address
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
- (NSString *) protocol [read, write, retain]

The protocol you want to use.

Supported protocols include:

  • http -- delivery of JSON-encoded message via HTTP POST
  • https -- delivery of JSON-encoded message via HTTPS POST
  • email -- delivery of message via SMTP
  • email-json -- delivery of JSON-encoded message via SMTP
  • sqs -- delivery of JSON-encoded message to an Amazon SQS queue

The documentation for this class was generated from the following file: