Wunderlist notifications channel for Laravel 5.3
PHP
Latest commit 3372967 Aug 31, 2016 @mpociot mpociot committed on GitHub Merge pull request #9 from JayBizzle/patch-1
Fix conditional that can never return
Permalink
Failed to load latest commit information.
src
tests
.editorconfig
.gitattributes
.gitignore
.scrutinizer.yml
.styleci.yml
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE.md
README.md
composer.json
phpunit.xml.dist

README.md

Wunderlist notifications channel for Laravel 5.3

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

This package makes it easy to create Wunderlist tasks with Laravel 5.3.

Contents

Installation

You can install the package via composer:

composer require laravel-notification-channels/wunderlist

Setting up the Wunderlist service

Create a new Wunderlist App.

Add your Wunderlist Client-ID to your config/services.php:

// config/services.php
...
'wunderlist' => [
    'key' => env('WUNDERLIST_API_KEY'),
],
...

Usage

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

use NotificationChannels\Wunderlist\WunderlistChannel;
use NotificationChannels\Wunderlist\WunderlistMessage;
use Illuminate\Notifications\Notification;

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

    public function toWunderlist($notifiable)
    {
        return WunderlistMessage::create('Another channel bites the dust')
            ->starred()
            ->due('tomorrow');
    }
}

In order to let your notification know which Wunderlist user and Wunderlist list you are targeting, add the routeNotificationForWunderlist method to your Notifiable model.

This method needs to return an array containing the access token of the authorized Wunderlist user and the list ID of the Wunderlist list to add the ticket to.

public function routeNotificationForWunderlist()
{
    return [
        'token' => 'NotifiableAccessToken',
        'list_id' => 12345,
    ];
}

Available methods

  • title(''): Accepts a string value for the Wunderlist ticket title.
  • assigneeId(''): Accepts a string value for the Wunderlist assignee id.
  • recurrenceCount(''): Accepts an integer value for the ticket recurrence count.
  • recurrenceType(''): Accepts one of these values for the recurrence type: WunderlistMessage::RECURRENCE_TYPE_DAY, WunderlistMessage::RECURRENCE_TYPE_WEEK, WunderlistMessage::RECURRENCE_TYPE_MONTH,WunderlistMessage::RECURRENCE_TYPE_YEAR
  • starred(): Marks the Wunderlist ticket as starred.
  • completed(): Marks the Wunderlist ticket as completed.
  • due(''): Accepts a string or DateTime object for the Wunderlist ticket due date.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email m.pociot@gmail.com 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.