streamNotifications: list of commands for rewrite

[brawaru]

This issue is to discuss the list of commands for the upcoming Stream Notifications module rewrite.

Current list of the commands

(prefix excluded)

Subscribe to a channel

• (User) streams subscribe [platform], [platformChannel]

• (Server) streams add [platform], [platformChannel], <channelResolvable>

Unsubscribe from a channel

• (User) streams unsubscribe [platform], [platformChannel]

• (User) streams unsubscribe [subscriptionId]

• (Server) streams remove [platform], [platformChannel], <channelResolvable>

  • Where platform is the same

• (Server) streams remove [subscriptionId]

Settings

This is a server-only command.

• streams settings [setting], [value]

Notifications Settings

This is both user and server available commands.

• streams channel_settings [platform], [platformChannel], <channelResolvable>, [setting], [value]

• streams channel_settings [subscriptionId], [setting], [value]

Subscriptions List

• streams list <platform>, <page>

Arguments

• platform is one of…

  • twitch
  • mixer
  • youtube
  • goodgame

• platformChannel is platform API-resolvable channel name

• subscriptionId — when subscription is created, the ID given, as well as seen in the list

---

• setting + value (in context of server notifications settings):
  • channel — channel where notifications sent
• setting + value (in context of channel notifications settings):
  • message_text — text for the notification
    • (format option) {everyone} — decorative @​everyone mention
    • (format option) {here} — decorative @​​here mention
    • (format option) {title} — title of the stream
    • (format option) {game} — name of the game (or “unspecified”)
• setting + value (in both contextes)
  • auto_delete — should notifications messages be deleted upon stream end
  • mature_behavoir — default behavior for streams marked “mature”
    Value is one of…
    • nothing (0) — send “as-is”
    • ignore (1) — do not send notification
    • banner (2) — do not display preview
    • governed (3) — governed by the channel where notification sent

---

• page — page to display