csgt/notification-channel-direkto

Notification channel Direkto.

v6.0.0 2021-04-23 02:56 UTC

This package is auto-updated.

Last update: 2024-10-23 10:39:38 UTC


README

Latest Version on Packagist Software License Total Downloads

This package makes it easy to send [Direkto notifications] with Laravel Laravel >5.4 branch 5.x Laravel >8 branch 6.x

Contents

Installation

You can install the package via composer:

composer require csgt/notification-channel-direkto

You must install the service provider:

// config/app.php
'providers' => [
    ...
    NotificationChannels\Direkto\DirektoProvider::class,
],

Setting up your Direkto account

Add your Direkto Account SID, Auth Token, and From Number (optional) to your config/services.php:

// config/services.php
...
'direkto' => [
    'account_url'   => env('DIREKTO_ACCOUNT_URL'),
    'account_token' => env('DIREKTO_AUTH_TOKEN'),
],
...

Usage

Now you can use the channel in your via() method inside the notification:

use NotificationChannels\Direkto\DirektoChannel;
use NotificationChannels\Direkto\DirektoMessage;
use Illuminate\Notifications\Notification;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return [DirektoChannel::class];
    }

    public function toDirekto($notifiable)
    {
        return (new DirektoMessage())
            ->content("Your {$notifiable->service} account was approved!");
    }
}

In order to let your Notification know which phone are you sending/calling to, the channel will look for the celular attribute of the Notifiable model. If you want to override this behaviour, add the routeNotificationForDirekto method to your Notifiable model.

public function routeNotificationForDirekto()
{
    return $this->mobile;
}

Available Message methods

DirektoSmsMessage

  • from(''): Accepts a phone to use as the notification sender.
  • content(''): Accepts a string value for the notification body.

Changelog

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email jgalindo@cs.com.gt instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.