library apn

laravel-notification-channels/apn

Apple APN Push Notification Channel

Laravel APN (Apple Push) Notification Channel

, _(*1)

This package makes it easy to send notifications using Apple Push (APN) with Laravel., _(*2)

Contents

• Installation
• Usage
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

Install this package with Composer:, _(*3)

composer require laravel-notification-channels/apn

Setting up the APN service

Before using the APN Service, enable Push Notifications in your app. Then create a APNS key under Certificates, Identifiers & Profiles to generate a Key ID and .p8 file., _(*4)

Collect your Key ID, as well as your Team ID (displayed at the top right of the Apple Developer page) and app bundle ID and configure as necessary in config/broadcasting.php., _(*5)

JWT Token Authentication

'connections' => [
    'apn' => [
        'key_id' => env('APN_KEY_ID'),
        'team_id' => env('APN_TEAM_ID'),
        'app_bundle_id' => env('APN_BUNDLE_ID'),
        // Enable either `private_key_path` or `private_key_content` depending on your environment
        // 'private_key_path' => env('APN_PRIVATE_KEY'),
        'private_key_content' => env('APN_PRIVATE_KEY'),
        'private_key_secret' => env('APN_PRIVATE_SECRET'),
        'production' => env('APN_PRODUCTION', true),
    ],
],

See the Establishing a token-based connection to APNs which will guide you how to obtain the values of the necessary parameters., _(*6)

Using Certificate (.pem) Authentication

'connections' => [
    'apn' => [
        'app_bundle_id' => env('APN_BUNDLE_ID'),
        'certificate_path' => env('APN_CERTIFICATE_PATH'),
        'certificate_secret' => env('APN_CERTIFICATE_SECRET'),
        'production' => env('APN_PRODUCTION', true),
    ],
],

If you are connecting with certificate based APNs, key_id and team_id are not needed. You can refer to Send a Push Notification Using a Certificate, _(*7)

See the Establishing a certificate-based connection to APNs which will guide you how to obtain the values of the necessary parameters., _(*8)

See the pushok docs for more information about what arguments can be supplied to the client., _(*9)

Usage

You can now send messages to APN by creating a ApnMessage:, _(*10)

use NotificationChannels\Apn\ApnChannel;
use NotificationChannels\Apn\ApnMessage;
use Illuminate\Notifications\Notification;

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

    public function toApn($notifiable)
    {
        return ApnMessage::create()
            ->badge(1)
            ->title('Account approved')
            ->body("Your {$notifiable->service} account was approved!");
    }
}

To see more of the methods available to you when creating a message please see the ApnMessage source., _(*11)

In your notifiable model, make sure to include a routeNotificationForApn() method, which return one or an array of tokens., _(*12)

public function routeNotificationForApn()
{
    return $this->apn_token;
}

Per-message configuration

If you need to provide a custom configuration for a message you can provide an instance of a Pushok client and it will be used instead of the default one., _(*13)

$customClient = new Pushok\Client(Pushok\AuthProvider\Token::create($options));

return ApnMessage::create()
    ->title('Account approved')
    ->body("Your {$notifiable->service} account was approved!")
    ->via($customClient)

VoIP push notifications

Sending VoIP push notifications is very similar. You just need to use the ApnVoipChannel channel with ApnVoipMessage (which has the same API as a regular ApnMessage)., _(*14)

use NotificationChannels\Apn\ApnVoipChannel;
use NotificationChannels\Apn\ApnVoipMessage;
use Illuminate\Notifications\Notification;

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

    public function toApnVoip($notifiable)
    {
        return ApnVoipMessage::create()
            ->badge(1);
    }
}

In your notifiable model, make sure to include a routeNotificationForApnVoip() method, which return one or an array of tokens., _(*15)

public function routeNotificationForApnVoip()
{
    return $this->apn_voip_token;
}

Changelog

Please see CHANGELOG for more information what has changed recently., _(*16)

Testing

bash $ composer test, _(*17)

Security

If you discover any security related issues, please email info@fruitcake.nl instead of using the issue tracker., _(*18)

Contributing

Please see CONTRIBUTING for details., _(*19)

Credits

• Fruitcake
• All Contributors

License

The MIT License (MIT). Please see License File for more information., _(*20)