v1.0.0
Search
K

NotificationService

notify

Sends a notification to a single notifiable instance or an array of notifiable instances.
Name
Type
Required
Default
Description
notifiables
true
A single Notifiable instance or an array of Notifiable instances that will receive the notification.
notification
string | BaseNotification
true
The notification instance or a string WireBox mapping to send to the notifiables.
properties
struct
false
{}
A struct of properties to populate the notification with.
Return: notification instance, after it has been populated and sent to the notifiables.

getChannel

Returns a channel instance by name.
Name
Type
Required
Default
Description
channelName
string
true
The name of the channel to return.
Return: A BaseProvider instance for the channel name.
Throws: Megaphone.Configuration.MissingChanel

getChannels

Returns a map of channel names to Provider instances.
Name
Type
Required
Default
Description
No arguments
Return: A struct map of channel names to Provider instances.