BaseProvider
getProviderName
Returns the name for this Provider.
This name should be the same across all different channels using the same Provider.
No arguments
Return: (string) The Provider name
notify
Sends a Notification
to a Notifiable
through this Channel instance using the configured Provider.
This method will be called once for each Notifiable
receiving the notification, even if the NotificationService#notify
method was called with multiple Notifiable
instances.
When implementing this method, make sure not to modify the Notification
instance as this instance will be used for each Notifiable
.
Return: Notification
instance, after it has been sent to the INotifiable
.
routeNotificationFor
Determines the route the notification should be sent to by calling the routeNotificationFor{ChannelType}
method, if it exists.
type
string
true
The type of channel to route to.
channelName
string
true
The name of the channel to route to.
additionalArgs
struct
false
{}
Any additional arguments to pass to the routing method (to{ChannelType}
method).
optional
boolean
false
false
Boolean flag determining if the routing method is optional or not.
Return: The result of the routeNotificationFor{ChannelType}
method. The variable type depends on the Provider.
Last updated