status-im
/
matterbridge
mirror of https://github.com/status-im/matterbridge.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve Markdown in transmitter docs (discord) (#1351)

This commit is contained in:
Qais Patankar 2021-01-03 18:57:06 +00:00 committed by GitHub
parent 16fde6935c
commit 8fcd0f3b6f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
bridge/discord/transmitter/transmitter.go
View File

@ -2,6 +2,7 @@
// arbitrary webhook messages to Discord. // arbitrary webhook messages to Discord.
// //
// The package provides the following functionality: // The package provides the following functionality:
//
// - Creating new webhooks, whenever necessary // - Creating new webhooks, whenever necessary
// - Loading webhooks that we have previously created // - Loading webhooks that we have previously created
// - Sending new messages // - Sending new messages
@ -43,9 +44,8 @@ var ErrWebhookNotFound = errors.New("webhook for this channel and message does n
// ErrPermissionDenied is returned if the bot does not have permission to manage webhooks. // ErrPermissionDenied is returned if the bot does not have permission to manage webhooks.
// //
// It's important to note that: // Bots can be granted a guild-wide permission and channel-specific permissions to manage webhooks.
// - a bot can have both a guild-wide permission and a channel-specific permission to manage webhooks // Despite potentially having guild-wide permission, channel specific overrides could deny a bot's permission to manage webhooks.
// - even if a bot has permission to manage the guild's webhooks, there could be channel specific overrides
var ErrPermissionDenied = errors.New("missing 'Manage Webhooks' permission") var ErrPermissionDenied = errors.New("missing 'Manage Webhooks' permission")
// New returns a new Transmitter given a Discord session, guild ID, and title. // New returns a new Transmitter given a Discord session, guild ID, and title.
@ -62,9 +62,7 @@ func New(session *discordgo.Session, guild string, title string, autoCreate bool
} }
} }
// Send transmits a message to the given channel with the provided webhook data. // Send transmits a message to the given channel with the provided webhook data, and waits until Discord responds with message data.
//
// Note that this function will wait until Discord responds with an answer.
func (t *Transmitter) Send(channelID string, params *discordgo.WebhookParams) (*discordgo.Message, error) { func (t *Transmitter) Send(channelID string, params *discordgo.WebhookParams) (*discordgo.Message, error) {
wh, err := t.getOrCreateWebhook(channelID) wh, err := t.getOrCreateWebhook(channelID)
if err != nil { if err != nil {
@ -124,16 +122,19 @@ func (t *Transmitter) AddWebhook(channelID string, webhook *discordgo.Webhook) b
// RefreshGuildWebhooks loads "relevant" webhooks into the transmitter, with careful permission handling. // RefreshGuildWebhooks loads "relevant" webhooks into the transmitter, with careful permission handling.
// //
// Notes: // Notes:
//
// - A webhook is "relevant" if it was created by this bot -- the ApplicationID should match the bot's ID. // - A webhook is "relevant" if it was created by this bot -- the ApplicationID should match the bot's ID.
// - The term "having permission" means having the "Manage Webhooks" permission. See ErrPermissionDenied for more information. // - The term "having permission" means having the "Manage Webhooks" permission. See ErrPermissionDenied for more information.
// - This function is additive and will not unload previously loaded webhooks. // - This function is additive and will not unload previously loaded webhooks.
// - A nil channelIDs slice is treated the same as an empty one. // - A nil channelIDs slice is treated the same as an empty one.
// //
// If the bot has guild-wide permission: // If the bot has guild-wide permission:
//
// 1. it will load any "relevant" webhooks from the entire guild // 1. it will load any "relevant" webhooks from the entire guild
// 2. the given slice is ignored // 2. the given slice is ignored
// //
// If the bot does not have guild-wide permission: // If the bot does not have guild-wide permission:
//
// 1. it will load any "relevant" webhooks in each channel // 1. it will load any "relevant" webhooks in each channel
// 2. a single error will be returned if any error occurs (incl. if there is no permission for any of these channels) // 2. a single error will be returned if any error occurs (incl. if there is no permission for any of these channels)
// //