laravel-notification-channels/workplace

Workplace notification channel

0.0.1 2020-01-01 00:25 UTC

Requires

• php: >=7.0
• guzzlehttp/guzzle: ^6.3
• illuminate/notifications: ~5.5 || ~6.0
• illuminate/support: ~5.5 || ~6.0

Requires (Dev)

• mockery/mockery: ^1.0
• phpunit/phpunit: 8.*

MIT

• Alexandre Lima
• Gonçalo Queirós

README

This package makes it easy to send notifications using Workplace with Laravel 5.5+ and 6.0

Contents

• Installation
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require laravel-notification-channels/workplace

Usage

You can now use the channel in your via() method inside the Notification class.

use NotificationChannels\Workplace\WorkplaceChannel;
use NotificationChannels\Workplace\WorkplaceMessage;
use Illuminate\Notifications\Notification;

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

    public function toWorkplace($notifiable)
    {
        return new WorkplaceMessage('# Laravel Notification Channels are awesome!');
    }
}

You also need to add the routeNotificationForWorkplace() method in your notifiable model:

class TestNotifiable
{
    use \Illuminate\Notifications\Notifiable;

    public function routeNotificationForWorkplace()
    {
        return 'https://graph.facebook.com/<groupId>/feed?access_token=<access_token>';
    }
}

Available Message methods

• content(''): (string) Notification message, supports markdown.
• asMarkdown(): Treats the message content as being Markdown (default)
• asPlainText(): Treats the message content as being plain text

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• Alexandre Lima
• Gonçalo Queirós
• All Contributors

License

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