Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vrajroham/laravel-flock-notification
Laravel Flock Notification Channel
https://github.com/vrajroham/laravel-flock-notification
Last synced: 1 day ago
JSON representation
Laravel Flock Notification Channel
- Host: GitHub
- URL: https://github.com/vrajroham/laravel-flock-notification
- Owner: vrajroham
- License: mit
- Created: 2018-03-28T18:48:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-12T07:22:24.000Z (about 2 years ago)
- Last Synced: 2024-06-17T08:44:03.389Z (5 months ago)
- Language: PHP
- Size: 29.3 KB
- Stars: 17
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Flock Notification Channel
[](https://packagist.org/packages/vrajroham/laravel-flock-notification)
[](LICENSE.md)
[](https://travis-ci.org/vrajroham/laravel-flock-notification)
[](https://styleci.io/repos/127184015)
[](https://scrutinizer-ci.com/g/vrajroham/laravel-flock-notification)
[](https://packagist.org/packages/vrajroham/laravel-flock-notification)
This package makes it easy to send notifications using [Flock](https://flock.com/) with Laravel 5.3+.
```php
return FlockMessage::create()
->content('Laravel Flock Notification Channel')
->attachment(function ($attachment) {
$attachment->title('Button Widget')
->description('Description')
->color('#fff000');
});
```
## Contents
- [Installation](#installation)
- [Setting up the Flock service](#setting-up-the-flock-service)
- [Usage](#usage)
- [Available Message methods](#available-message-methods)
- [Examples](#examples)
- [Changelog](#changelog)
- [Testing](#testing)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
Install this package with Composer:
composer require vrajroham/laravel-flock-notification
Register the ServiceProvider in your config/app.php (If you are using Laravel < 5.5):
Vrajroham\LaravelFlockNotification\FlockServiceProvider::class,
## Setting up the flock service
Create incoming webhook by going to [https://admin/flock.com](https://admin.flock.com) or by choosing **Manage your team** in Flock desktop app.
For more information see the [flock documentation](https://docs.flock.com/display/flockos/Create+An+Incoming+Webhook) to create incoming webhook.
## Usage
You can now send messages in Flock Group by creating a FlockMessage:
- Add `routeNotificationForFlock()` to `App\User` model
```php
public function routeNotificationForFlock()
{
return $this->flock_webhook_url;
}
```
```php
content('Order created')
->attachments(function ($attachment) {
$attachment->title('View order')
->description('Order description')
->color('#fff000');
});
}
}
```
### Available Message methods
Complete message and attachment schema can be found at [Flock Message Object](https://docs.flock.com/display/flockos/Message) and [Flock Attachment Object](https://docs.flock.com/display/flockos/Attachment)
- content(`$string`)
- flockml(`$string`) _//[FlockML](https://docs.flock.com/display/flockos/FlockML) as attachment_
- notification(`$string`)
- sendAs(`$senderName`, `$profileImageUrl`)
- attachments(`callback`)
+ title(`$string`)
+ description(`$string`)
+ color(`$string`)
+ url(`$url`)
+ id(`$string`)
+ forward(`$boolean`)
+ views(`callback`)
* widget(`$source`, `$height`, `$width`)
* html(`$inlineHtmlString`, `$height`, `$width`)
* flockml(`$flockMLString`)
* image(`callback`)
- original(`$url`, `$height`, `$width`)
- thumbnail(`$url`, `$height`, `$width`)
- filename(`$filename`)
+ downloads(`array`)
```php
// Only 'src' field is mandatory.
[
[
'src' => 'https://vrajroham.me/dl/vrajroham_cv.pdf',
'mime' => 'application/pdf',
'filename' => 'CV.pdf',
'size' => 2000 //bytes
],
...
]
```
- buttons(`array`)
```php
[
[
'name' => 'Button Name',
'icon' => 'https://avatars1.githubusercontent.com/u/12662173?s=460&v=4',
'action' => [
'type' => 'openBrowser',
'url' => 'https://laravel.com',
'desktopType' => 'sidebar',
],
'id' => 'btn1'
],
...
]
```
## Examples
#### Text as contents
```php
public function toFlock($notifiable)
{
return FlockMessage::create()
->content('This is text notification.');
}
```
#### Change sender name and image
```php
public function toFlock($notifiable)
{
return FlockMessage::create()
->content('This is text notification.')
->sendAs("Vaibhavraj", 'https://avatars1.githubusercontent.com/u/12662173?s=460&v=4');
}
```
#### Change message color
```php
public function toFlock($notifiable)
{
return FlockMessage::create()
->attachments(function ($attachment){
$attachment->title('This is error message.')
->color('#FF0000'); //Red
});
}
```
#### Change notification text for mobile application
```php
public function toFlock($notifiable)
{
return FlockMessage::create()
->notification('You have important message')
->content('This is text notification.');
}
```
#### Website as widget
```php
public function toFlock($notifiable)
{
return FlockMessage::create()
->attachments(function ($attachment){
$attachment->title('Website as widget')
->views(function ($view){
$view->widget('https://vrajroham.me', 400, 400);
});
});
}
```
#### Buttons
```php
public function toFlock($notifiable)
{
return FlockMessage::create()
->attachments(function ($attachment){
$attachment->title('This are the buttons')
->buttons([
[
'name' => 'Button 1',
'icon' => 'https://avatars1.githubusercontent.com/u/12662173?s=460&v=4',
'action' => [
'type' => 'openBrowser',
'url' => 'https://github.com/vrajroham',
],
'id' => 'btn1'
],
[
'name' => 'Button 2',
'icon' => 'https://laravel.com/favicon.png',
'action' => [
'type' => 'openBrowser',
'url' => 'https://laravel.com',
],
'id' => 'btn2'
]
]);
});
}
```
#### Image as attachment
```php
public function toFlock($notifiable)
{
return FlockMessage::create()
->attachments(function ($attachment) {
$attachment->title('Image as attachment')
->views(function ($view) {
$view->image(function ($image)
{
$image->original('https://avatars1.githubusercontent.com/u/12662173?s=460&v=4',400,400)
->thumbnail('https://avatars1.githubusercontent.com/u/12662173?s=460&v=4',100,100)
->filename('vaibhavraj.png');
});
});
});
}
```
#### Download Link
```php
public function toFlock($notifiable)
{
return FlockMessage::create()
->attachments(function ($attachment) {
$attachment->title('Download link')
->downloads([
[
'src' => 'https://vrajroham.me/dl/vrajroham_cv.pdf',
'mime' => 'application/pdf',
'filename' => 'file-1.pdf',
'size' => 1500
],
]);
});
}
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
```
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for more information about contributors.
## Credits
- [Vaibhavraj Roham](https://github.com/vrajroham)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.