PHPackages                             fei/notification-common - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. fei/notification-common

ActiveLibrary[Mail & Notifications](/categories/mail)

fei/notification-common
=======================

Flash Notification - Common components

v1.3.0(7y ago)09.0k1GPL-3.0PHPPHP >=7.0CI failing

Since Sep 15Pushed 7y ago22 watchersCompare

[ Source](https://github.com/flash-global/notification-common)[ Packagist](https://packagist.org/packages/fei/notification-common)[ RSS](/packages/fei-notification-common/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)Dependencies (11)Versions (23)Used By (1)

Service Notification - Common
=============================

[](#service-notification---common)

[![GitHub release](https://camo.githubusercontent.com/cc208b3b19fe9be04e4465697ba8bd7eed55a89173e88849f6cbb12a9e77db19/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f666c6173682d676c6f62616c2f6e6f74696669636174696f6e2d636f6d6d6f6e2e7376673f7374796c653d666f722d7468652d6261646765)](README.md)

Table of contents
-----------------

[](#table-of-contents)

- [Entities](#entities)
- [Contribution](#contribution)
- [Examples](#examples)

Entities
--------

[](#entities)

### Notification

[](#notification)

PropertiesTypeRequiredDefault valueid`integer`NocreatedAt`datetime`NoNow()origin`string`Yesrecipient`string`Yesevent`string`Yesmessage`string`Yestype`integer`No1status`integer`No0parentNotificationId`integer`No0context`json`Noaction`json`No- `origin`is a string representing the origin of the notification
- `recipient`is a string representing the recipient of the notification
- `event`is a string representing the event linked to the notification
- `message`is a string indicating the message
- `type` is an integer representing the type of the notification. 1 : Info, 2 : Warning
- `status` is an integer representing the status of the notification. 0 : Unread, 1 : Read, 2 : Acknowledged
- `parentNotificationId` is an integer representing the parent notification
- `context` is a json
- `action` is a json

### Android alert entity

[](#android-alert-entity)

PropertiesTypeRequirednotification `Notification` Yes message `Message` Yes - `message`is a Message (described below) indicating the message

### Message (Android alert)

[](#message-android-alert)

PropertiesTypeRequireddata `array` Notoken`string`Notopic`string`Nocondition`string`Nonotification`Android\Notification`Yes### Android\\Notification (Android alert)

[](#androidnotification-android-alert)

PropertiesTypeRequiredtitle `string` Yesbody`string`Yes### Email alert entity

[](#email-alert-entity)

PropertiesTypeRequirednotification `Notification` Yes email`string`Yessubject`string`Yescontent`string`Yes- `email`is a string representing the email recipient
- `subject`is a string indicating the subject of the email
- `content`is a string representing the content of the email

### SMS alert entity

[](#sms-alert-entity)

PropertiesTypeRequirednotification `Notification` Yes message `Message` Yes - `message`is a Message (described below) indicating the message

### Message (SMS alert)

[](#message-sms-alert)

PropertiesTypefrom `string` recipients`array`content`string`Contribution
------------

[](#contribution)

As FEI Service, designed and made by OpCoding. The contribution workflow will involve both technical teams. Feel free to contribute, to improve features and apply patches, but keep in mind to carefully deal with pull request. Merging must be the product of complete discussions between Flash and OpCoding teams :)

Examples
--------

[](#examples)

You have the possibility to validate a `Notification` entity with NotificationValidator class:

```