Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.PublishAsync C# (CSharp) Method

PublishAsync() public method

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.

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 for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

/// Indicates that the user has been denied access to the requested resource. /// /// Exception error indicating endpoint disabled. /// /// Indicates an internal service error. /// /// Indicates that a request parameter does not comply with the associated constraints. /// /// Indicates that a request parameter does not comply with the associated constraints. /// /// Indicates that the requested resource does not exist. /// /// Exception error indicating platform application disabled. ///
public PublishAsync ( string topicArn, string message, System cancellationToken = default(CancellationToken) ) : Task
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).
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task
        public Task<PublishResponse> PublishAsync(string topicArn, string message, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
        {
            var request = new PublishRequest();
            request.TopicArn = topicArn;
            request.Message = message;
            return PublishAsync(request, cancellationToken);
        }

Same methods

AmazonSimpleNotificationServiceClient::PublishAsync ( PublishRequest request, System cancellationToken = default(CancellationToken) ) : Task
AmazonSimpleNotificationServiceClient::PublishAsync ( string topicArn, string message, string subject, System cancellationToken = default(CancellationToken) ) : Task
AmazonSimpleNotificationServiceClient::PublishAsync ( PublishRequest request, PublishResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
AmazonSimpleNotificationServiceClient::PublishAsync ( string topicArn, string message, PublishResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
AmazonSimpleNotificationServiceClient::PublishAsync ( string topicArn, string message, string subject, PublishResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void

Usage Example

Esempio n. 1
0
 /// <summary>
 /// returns nothing on error
 /// </summary>
 public string PublishRawMessage(string topicArn, string rawMessage)
 {
     try {
         using (var client = new AmazonSimpleNotificationServiceClient(this.AwsCredentials, this.AwsRegion)) {
             var pr = new PublishRequest();
             pr.TopicArn = topicArn;
             pr.Message  = rawMessage;
             var t = client.PublishAsync(pr);
             t.Wait();
             if (t.IsCompleted && t.Result is object)
             {
                 Trace.TraceInformation($"Outgoing SNS-Message for Topic '{topicArn}' Msg-ID: {t.Result.MessageId}");
                 return(t.Result.MessageId);
             }
             else
             {
                 Trace.TraceError($"Publish SNS-Message for Topic '{topicArn}' FAILED: AWS responded non-success");
                 return(null);
             }
         }
     }
     catch (Exception ex) {
         Trace.TraceError($"Publish SNS-Message for Topic '{topicArn}' EXCEPTION: {ex.Message}");
         return(null);
     }
 }
All Usage Examples Of Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient::PublishAsync
AmazonSimpleNotificationServiceClient