Public Member Functions | Properties

SNSPublishRequest Class Reference

Publish Request. More...

#import <SNSPublishRequest.h>

List of all members.

Public Member Functions

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

Properties

NSString * topicArn
 The topic you want to publish to.
NSString * message
 The message you want to send to the topic.
NSString * subject
 Optional parameter to be used as the "Subject" line of when the message is delivered to e-mail endpoints.

Detailed Description

Publish Request.


Member Function Documentation

- (NSString* SNSPublishRequest.)description  

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

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

Default constructor for a new PublishRequest object.

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

- (id SNSPublishRequest.)initWithTopicArn: (NSString *)  theTopicArn
andMessage: (NSString *)  theMessage 

Constructs a new PublishRequest object.

Callers should use properties to initialize any additional object members.

Parameters:
theTopicArn The topic you want to publish to.
theMessage The message you want to send to the topic.

Constraints: Messages must be UTF-8 encoded strings at most 8 KB in size (8192 bytes, not 8192 characters).

- (id SNSPublishRequest.)initWithTopicArn: (NSString *)  theTopicArn
andMessage: (NSString *)  theMessage
andSubject: (NSString *)  theSubject 

Constructs a new PublishRequest object.

Callers should use properties to initialize any additional object members.

Parameters:
theTopicArn The topic you want to publish to.
theMessage The message you want to send to the topic.

Constraints: Messages must be UTF-8 encoded strings at most 8 KB in size (8192 bytes, not 8192 characters).

Parameters:
theSubject Optional parameter to be used as the "Subject" line of when the message is delivered to e-mail endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Constraints: Subjects must be ASCII text that begins with a letter, number or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.


Property Documentation

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

The message you want to send to the topic.

Constraints: Messages must be UTF-8 encoded strings at most 8 KB in size (8192 bytes, not 8192 characters).

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

Optional parameter to be used as the "Subject" line of when the message is delivered to e-mail endpoints.

This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Constraints: Subjects must be ASCII text that begins with a letter, number or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.


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