Download the PHP package ilyahoilik/discord-notification-channel without Composer
On this page you can find all versions of the php package ilyahoilik/discord-notification-channel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ilyahoilik/discord-notification-channel
More information about ilyahoilik/discord-notification-channel
Files in ilyahoilik/discord-notification-channel
Package discord-notification-channel
Short Description Laravel notification driver for Discord.
License MIT
Homepage https://github.com/ilyahoilik/discord-notification-channel
Informations about the package discord-notification-channel
Discord notification channel for Laravel 6.0+
This package makes it easy to send notifications using the Discord bot API with Laravel.
Contents
- Discord notification channel for Laravel 6.0+
- Contents
- Installation
- Setting up your Discord bot
- Usage
- Available Message methods
- Changelog
- Testing
- Security
- Contributing
- Credits
- License
Installation
You can install the package via composer:
Next, you must load the service provider:
Setting up your Discord bot
- Create a Discord application.
- Click the
Create a Bot User
button on your Discord application. -
Paste your bot's API token, found under
App Bot User
, in yourservices.php
config file: - Add the bot to your server and identify it by running the artisan command:
Usage
In every model you wish to be notifiable via Discord, you must add a channel ID property to that model accessible through a routeNotificationForDiscord
method:
NOTE: Discord handles direct messages as though they are a regular channel. If you wish to allow users to receive direct messages from your bot, you will need to create a private channel with that user.
An example workflow may look like the following:
- Your
users
table has two discord columns:discord_user_id
anddiscord_private_channel_id
- When a user updates their Discord user ID (
discord_user_id
), generate and save a private channel ID (discord_private_channel_id
)- Return the user's
discord_private_channel_id
in therouteNotificationForDiscord
method on theUser
modelYou can generate direct message channels by using the
getPrivateChannel
method in theNotificationChannels\Discord\Discord
classPlease take note that the
getPrivateChannel
method only accepts Discord's snowflake IDs. There is no API route provided by Discord to lookup a user's ID by their name and tag, and the process for copying and pasting a user ID can be confusing to some users. Because of this, it is recommended to add the option for users to connect their Discord account to their account within your application either by logging in with Discord or linking it to their pre-existing account.
You may now tell Laravel to send notifications to Discord channels in the via
method:
Available Message methods
body(string)
: Set the content of the message. (Supports basic markdown)embed(array)
: Set the embedded content. (View embed structure)components(array)
: Set the component content. (View component structure)
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
- Cody Scott
- All Contributors
License
The MIT License (MIT). Please see LICENSE for more information.
All versions of discord-notification-channel with dependencies
guzzlehttp/guzzle Version ^6.3 || ^7.0
textalk/websocket Version ^1.2
illuminate/notifications Version ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
illuminate/support Version ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
illuminate/queue Version ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
illuminate/console Version ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
php Version ^8.0