Skip to main content

Amazon SNS

This library allows you to interact with the Amazon SNS Service.

Prerequisites​

Installation​

npm i @winglibs/sns

Usage​

bring sns;

let client = new sns.MobileNotifications();

test "sending an SMS" {
client.publish(PhoneNumber: "+14155552671", Message: "Hello");
}

License​

This library is licensed under the MIT License.​

API Reference​

Table of Contents​

MobileNotifications_sim (preflight class) ​

No description

Constructor​

new(): MobileNotifications_sim

Properties​

No properties

Methods​

SignatureDescription
inflight publish(options: PublishOptions): PublishResultNo description

MobileNotifications (preflight class) ​

MobileNotifications is a client for interacting with SNS mobile service. No cloud resources are created when using this class. When running the simulator in a non test environment, it will use the actual cloud implementation.

Constructor​

new(): MobileNotifications

Properties​

No properties

Methods​

SignatureDescription
inflight publish(options: PublishOptions): PublishResultNo description

MobileNotifications_aws (preflight class) ​

No description

Constructor​

new(): MobileNotifications_aws

Properties​

No properties

Methods​

SignatureDescription
inflight publish(options: PublishOptions): PublishResultNo description

IMobileNotifications (interface) ​

No description

Properties​

No properties

Methods​

SignatureDescription
inflight publish(options: PublishOptions): PublishResultNo description

MessageAttributeValue (struct) ​

No description

Properties​

NameTypeDescription
DataTypestr?No description
StringValuestr?No description

PublishOptions (struct) ​

No description

Properties​

NameTypeDescription
Messagestr?No description
MessageAttributes
Map?
No description
PhoneNumberstr?No description
Subjectstr?No description
TopicArnstr?No description

PublishResult (struct) ​

No description

Properties​

NameTypeDescription
MessageIdstr?No description
SequenceNumberstr?No description