Giter VIP home page Giter VIP logo

spryng's Introduction

Spryng Notification Channel

Latest Version on Packagist Software License Build Status StyleCI SensioLabsInsight Quality Score Code Coverage Total Downloads

๐Ÿ“ฒ Spryng Notifications Channel for Laravel

Contents

Installation

composer require laravel-notification-channels/spryng

Add the configuration to your services.php config file:

'spryng' => [
    'key' => env('SPRYNG_API_KEY'),
]

Setting up the Spryng service

You'll need a Spryng account. Head over to their website and create or login to your account.

Head to your Profile and then Security in the sidebar to generate a set of API keys.

Usage

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

use Illuminate\Notifications\Notification;
use \NotificationChannels\Spryng\SpryngMessage;
use \NotificationChannels\Spryng\SpryngChannel;

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

    public function toSpryng($notifiable)
    {
        return (new SpryngMessage)
			->setBody("Task #{$notifiable->id} is complete!")
			->setRecipients($notifiable->phone_number)
			->setOriginator(config('app.name'));
    }
}

Make sure your Notifiable model has a phone_number attribute, which will be used to send the SMS. Also make sure it's a valid phone number.

Available Message methods

  • setBody(''): Accepts a string value for the message body.
  • setRecipients(''): Accepts a string or array value for the recipient(s) phone number.
  • setOriginator(''): Accepts a string value for the sender name.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [email protected] 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.

spryng's People

Contributors

baspa avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.