Download the PHP package laravel-notification-channels/rocket-chat without Composer
On this page you can find all versions of the php package laravel-notification-channels/rocket-chat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laravel-notification-channels/rocket-chat
More information about laravel-notification-channels/rocket-chat
Files in laravel-notification-channels/rocket-chat
Package rocket-chat
Short Description Rocket.Chat Notifications channel for Laravel 5.6+
License MIT
Homepage https://github.com/laravel-notification-channels/rocket-chat
Informations about the package rocket-chat
Rocket.Chat Laravel Notifications Channel
Introduction
This package makes it easy to send notifications using RocketChat with Laravel 5.6+.
Contents
- Installation
- Setting up the RocketChat service
- Usage
- Available Message methods
- Changelog
- Testing
- Security
- Contributing
- Credits
- Change log
- License
Installation
You can install the package via composer:
Setting up the RocketChat service
In order to send message to RocketChat channels, you need to obtain Webhook.
Add your RocketChat API server's base url, incoming Webhook Token and optionally the default channel to your config/services.php
:
Usage
You can use the channel in your via()
method inside the notification:
In order to let your notification know which RocketChat channel you are targeting, add the routeNotificationForRocketChat
method to your Notifiable model:
Available methods
from()
: Sets the sender's access token.
to()
: Specifies the channel id to send the notification to (overridden by routeNotificationForRocketChat
if empty).
content()
: Sets a content of the notification message. Supports Github flavoured markdown.
alias()
: This will cause the message’s name to appear as the given alias, but your username will still display.
emoji()
: This will make the avatar on this message be an emoji. (e.g. ':see_no_evil:')
avatar()
: This will make the avatar use the provided image url.
attachment()
: This will add an single attachment.
attachments()
: This will add multiple attachments.
clearAttachments()
: This will remove all attachments.
Adding Attachment
There are several ways to add one ore more attachments to a message
Available methods
color()
: The color you want the order on the left side to be, any value background-css supports.
text()
: The text to display for this attachment, it is different than the message’s text.
timestamp()
: Displays the time next to the text portion. ISO8601 Zulu Date or instance of any \DateTime
thumbnailUrl()
: An image that displays to the left of the text, looks better when this is relatively small.
messageLink()
: Only applicable if the ts is provided, as it makes the time clickable to this link.
collapsed()
: Causes the image, audio, and video sections to be hiding when collapsed is true.
author($name, $link, $icon)
: shortcut for author methods
authorName()
: Name of the author.
authorLink()
: Providing this makes the author name clickable and points to this link.
authorIcon()
: Displays a tiny icon to the left of the Author’s name.
title()
: Title to display for this attachment, displays under the author.
titleLink()
: Providing this makes the title clickable, pointing to this link.
titleLinkDownload()
: When this is true, a download icon appears and clicking this saves the link to file.
imageUrl()
: The image to display, will be “big” and easy to see.
audioUrl()
: Audio file to play, only supports what html audio does.
videoUrl()
: Video file to play, only supports what html video does.
fields()
: An array of Attachment Field Objects.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Credits
- Anton Komarev
- Nicholas
- atymic
- All Contributors
Change log
Please see CHANGELOG for more information on what has changed recently.
License
The MIT License (MIT). Please see License File for more information.
About CyberCog
CyberCog is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion.
All versions of rocket-chat with dependencies
guzzlehttp/guzzle Version ^6.3|^7.0
illuminate/notifications Version ^5.6|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
illuminate/queue Version ^5.6|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
illuminate/support Version ^5.6|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0