e2kaneko/laravel-chatwork-notifications

Chatwork notifications channel for Laravel.

1.0.0 2017-01-04 11:51 UTC

Requires

• php: >=5.6.4
• guzzlehttp/guzzle: ~6.0
• illuminate/notifications: ^5.3
• illuminate/support: ^5.1|^5.2|^5.3

Requires (Dev)

• mockery/mockery: ^0.9.5
• orchestra/database: 3.3.x-dev
• orchestra/testbench: 3.3.x-dev
• phpunit/phpunit: 4.*

MIT

• e2kaneko

README

This package makes it easy to send Chatwork messages using Chatwork API with Laravel 5.3.

Contents

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

Installation

You can install the package via composer:

composer require e2kaneko/laravel-chatwork-notifications

You must install the service provider:

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

Configuration

Configure your credentials:

// config/services.php
...
'chatwork' => [
    'api_token' => env('CHATWORK_API_TOKEN'),
],
...

Usage

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

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use NotificationChannels\Chatwork\ChatworkMessage;
use NotificationChannels\Chatwork\ChatworkChannel;

class ChatworkPosted extends Notification
{

    use Queueable;

    public function __construct()
    {
    }

    public function via($notifiable)
    {
        return [ChatworkChannel::class];
    }

    public function toChatwork($notifiable)
    {
        return (new ChatworkMessage())
                        ->message('message');
    }
}

or

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use NotificationChannels\Chatwork\ChatworkInformation;
use NotificationChannels\Chatwork\ChatworkChannel;

class ChatworkPosted extends Notification
{

    use Queueable;

    public function __construct()
    {
    }

    public function via($notifiable)
    {
        return [ChatworkChannel::class];
    }

    public function toChatwork($notifiable)
    {
        return (new ChatworkInformation())
                        ->informationTitle('InformationTitle')
                        ->informationMessage('InformationMessage');
    }
}

Routing a message

You can either send the notification by providing with the room_id of the recipient to the roomId($roomId) method like shown in the above example or add a routeNotificationForChatwork() method in your notifiable model:

...
/**
 * Route notifications for the Chatwork channel.
 *
 * @return int
 */
public function routeNotificationForChatwork()
{
    return '99999999'; // Chatwork Room ID
}
...

Available Message methods

Message(ChatworkMessage)

• roomId('roomId'): (integer|string) Chatwork Room ID.
• to('accountId'): (integer|string) .
• message('message'): (string) Chat message.

Information(ChatworkInformation)

• roomId('roomId'): (integer|string) Chatwork Room ID.
• informationTitle('title'): (string) Information Box Title.
• informationMessage('message'): (string) Information Box Message.

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

• Tomohiro Kaneko
• All Contributors

License

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