Skip to content

[WIP] Start the Notifier Component documentation #12981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

[WIP] Start the Notifier Component documentation #12981

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f4e1ef
Start the Notifier Component documentation
savvasal Jan 24, 2020
5e8c1f0
Fix doc issues
savvasal Jan 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions components/notifier.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,40 @@ Installation
Usage
-----

.. caution::
Transport
---------

We're still working on the docs of this component. Check this page again
in a few days.
Every Notification, Text or Chat Message needs a Transport in order to be delivered.

There are implement Transports for Slack, Twilio, Nexmo and Telegram.

You can create a Transport by implementing the TransportInterface.

For example you can send a Chat Message to a Slack Transport::

$slackTransport = new SlackTransport(
'xxxx-xxxxxxxxx-xxxx',
'C1234567890',
new CurlHttpClient()
);
$chatMessage = new ChatMessage('Contribute to Symfony! It\'s fun and a great experience.');
$slackTransport->send($chatMessage);

Notifier
--------


Chatter
-------

Texter
------

Channel
-------

Message
-------

Recipient
---------