README

A Laravel 5 package for Android and iOS push notification service from https://pushover.net/.

**Please if you found any bug or you have any enhancement, You're so welcomed to open an Issue or make a pull request.

Content

Installation
Configuration
Usage
Commands
License

Installation

If you still using laravel 4.1 use the 1.3.0 version

To get the latest version of dyaa/pushover simply require it in your composer.json file.

"dyaa/pushover": "dev-master"

After that, you'll need to run composer update to download the latest Version and updating the autoloader.

composer require dyaa/pushover:dev-master

Once dyaa/pushover is installed, you need to register the Service Provider. To do that open app/config/app.php and add the following to the providers key.

'Dyaa\Pushover\PushoverServiceProvider',

Next you add this facade to app/config/app.php

'Dyaa\Pushover\Facades\Pushover',

To use this in your L5 application:

use Dyaa\Pushover\Facades\Pushover;

Configuration

Create app/config/pushover.php and fill it with your Token and the User Key from https://pushover.net/

return [
    'token' => 'App Token',
    'user_key' => 'User Key',
];

Usage

Now you can use the package like that:

To Set a message (Required)

Pushover::push($title, $message);

To Set a Link (Optional)

Pushover::url($url, $title);

To Set a Callback (Optional)

Pushover::callback($callbackURL);

To Set a Sound (Optional) Supported Notification Sounds https://pushover.net/api#sounds

Pushover::sound($sound);

To Set a Device Name (Optional)

Pushover::device($device);

To Set if the Message should be sent as HTML (Optional) Default is 1

Pushover::html($html);

To Set a Timestamp (Optional) Default is time()

Pushover::timestamp($timestamp);

To Set Priority (Optional) For More Info about Priority https://pushover.net/api#priority

Pushover::priority($priority, $retry, $expire);

To turn the Debug mode (Optional)

Pushover::debug(true);

To Send the Message (Required)

Pushover::send();

All other information will be found in details here https://pushover.net/api

Commands

In the version 1.2.0 and above it supports the Artisan Commands but first make sure that you've done the Configuration correctly.

You can run

php artisan list

and you'll find

pushover
pushover:send               Pushover Command

To send a pushover message you'll be able to use it like this way ( Title and Message are Required )

php artisan pushover:send YourTitle YourMessage

to turn on the debug mode just add

--debug

in the end of the Command line

to set a sound you can add "Optional"

--sound=YourSound

To know the supported sounds from here https://pushover.net/api#sounds

to set a Device name "Optional"

--device=YourDeviceName

to send a URL "Optional"

--url=http://www.example.com/

to set a title for the URL "Optional"

--urltitle=UrlTitle

to set a priority Message you can know more about the Priority Messages from here https://pushover.net/api#priority "Optional"

--priority=1

to set a priority retry (in seconds) Default is 60 "Optional"

--retry=60

to set a priority expire (in seconds) Default is 356 "Optional"

--expire=356

to set if message should be sent as HTML. Default is 1 "Optional" Note: Message body needs to be wrapped in quotes.

--html=1

daltcore / pushover

Maintainers

Details