C# Класс Amazon.SimpleNotificationService.Model.PublishRequest

Container for the parameters to the Publish operation.

The Publish action sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.

Наследование: AmazonSimpleNotificationServiceRequest
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
PublishRequest ( ) : System

Empty constructor used to set properties independently even when a simple constructor is available
PublishRequest ( string topicArn, string message ) : System

Instantiates PublishRequest with the parameterized properties
PublishRequest ( string topicArn, string message, string subject ) : System

Instantiates PublishRequest with the parameterized properties

Приватные методы

Метод Описание
IsSetMessage ( ) : bool
IsSetMessageAttributes ( ) : bool
IsSetMessageStructure ( ) : bool
IsSetPhoneNumber ( ) : bool
IsSetSubject ( ) : bool
IsSetTargetArn ( ) : bool
IsSetTopicArn ( ) : bool

Описание методов

PublishRequest() публичный Метод

Empty constructor used to set properties independently even when a simple constructor is available
public PublishRequest ( ) : System
Результат System

PublishRequest() публичный Метод

Instantiates PublishRequest with the parameterized properties
public PublishRequest ( string topicArn, string message ) : System
topicArn string The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.
message string The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
Результат System

PublishRequest() публичный Метод

Instantiates PublishRequest with the parameterized properties
public PublishRequest ( string topicArn, string message, string subject ) : System
topicArn string The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.
message string The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter. Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters). JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
subject string Optional parameter to be used as the "Subject" line when the message is delivered to email 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.
Результат System