basalt / notifications/src / SmsChannel

Class: SmsChannel

Defined in: notifications/src/channels.ts:192

Delivers notifications over an SmsSender. Works for both SMS and WhatsApp — the only difference is the channel name and how the address is read, both configurable. Honours per-recipient opt-out via channelPreferences (e.g. { sms: false }), like every channel.

Implements

NotificationChannel

Constructors

Constructor

> new SmsChannel(sender, options?): SmsChannel

Defined in: notifications/src/channels.ts:197

Parameters

sender

options?

SmsChannelOptions = {}

Returns

SmsChannel

Properties

name

> readonly name: string

Defined in: notifications/src/channels.ts:193

Implementation of

NotificationChannel.name

Methods

send()

> send(recipient, message, _info): Promise<void>

Defined in: notifications/src/channels.ts:206

Parameters

recipient

message

unknown

_info

notification

string

Returns

Promise<void>

Implementation of

NotificationChannel.send