package hourai.db.proto

Get desktop application:
View/edit binary Protocol Buffers messages

NEXT ID: 15

Used in: ActionSet, EscalationLadderRung, Event, MessageEvent, MessageFilterRule, UserChangeEvent

• optional uint64 user_id = 1

• optional uint64 guild_id = 11

• optional string reason = 2

• optional uint64 duration = 3

  Optional: duration, in seconds, after which the action is undone.

• oneof details

  • KickMember kick = 4

  • BanMember ban = 5

  • EscalateMember escalate = 6

  • MuteMember mute = 12

  • DeafenMember deafen = 13

  • ChangeRole change_role = 7

  • DirectMessage direct_message = 8

  • SendMessage send_message = 9

  • DeleteMessages delete_messages = 14

NEXT ID: 3

Used in: MessageComponentProto

• optional fixed64 required_permissions = 1

• optional ActionSet actions = 2

NEXT ID: 2

Used in: ActionButton

• repeated Action action = 1

Used in: GuildConfig

• optional AnnouncementTypeConfig joins = 1

• optional AnnouncementTypeConfig leaves = 2

• optional AnnouncementTypeConfig bans = 3

• optional AnnouncementTypeConfig streams = 4

• optional AnnouncementTypeConfig voice = 5

Used in: AnnouncementConfig

• repeated uint64 channel_ids = 1

  Required. The channels to output the announcements to.

• repeated string messages = 2

  Optional: Custom messages used. If none are provided, the default message will be used.

Used in: GuildConfig

• optional EventGroup guild_events = 1

• map<string, EventGroup> channel_events = 2

Used in: VerificationConfig

• optional bool reject_default_avatars = 1

  TODO(james7132): Enable this when adding further avatar verification. optional bool reject_sexual_avatars = 1 [default = true]; optional bool reject_violent_avatars = 1 [default = true];

Used to cache information about user bans

• optional uint64 guild_id = 1

  NEXT ID: 7

• optional uint64 guild_size = 2

• optional bool guild_blocked = 6

• optional uint64 user_id = 3

• optional string reason = 4

• optional string avatar = 5

NEXT ID: 4

Used in: Action

• optional BanMember.Type type = 2

  Required: if set to true, the user will immediately be unbanned following the ban.

• optional uint32 delete_message_days = 3

  Optional: If set, the ban will delete the last X days of messages from the user in the server.

Used in: BanMember

• BAN = 1

  Bans a user from the server.

• UNBAN = 2

  Unbans a user from the server.

• SOFTBAN = 3

  Bans then immediately unbans the user from the server. Useful for deleting the user's messages via bans.

Used in: EventSource

• optional DiscordMessage message = 1

NEXT ID: 2

• optional fixed64 channel_id = 1

• optional string name = 2

NEXT ID: 7

• optional fixed64 id = 1

• optional string name = 2

• optional string description = 3

• repeated string features = 4

• optional fixed64 owner_id = 5

• optional string vanity_url_code = 6

NEXT ID: 6

• optional fixed64 id = 1

• optional fixed64 channel_id = 2

• optional fixed64 guild_id = 3

• optional CachedUserProto author = 4

• optional string content = 5

NEXT ID: 5

• optional fixed64 role_id = 1

• optional string name = 2

• optional int64 position = 3

• optional fixed64 permissions = 4

NEXT ID: 6

Used in: CachedMessageProto, TrackProto

• optional fixed64 id = 1

• optional string username = 2

• optional uint32 discriminator = 3

• optional string avatar = 4

• optional bool bot = 5

NEXT ID: 3

Used in: Action

• optional StatusType type = 1

  Required: the direction and change that was applied.

• repeated uint64 role_ids = 2

  Required: the roles used by the action.

Used in: VerificationConfig

• optional bool reject_banned_users = 1

  Optional: If set to true, users banned from other servers

• optional uint64 minimum_guild_size = 2

  Optional: This marks the minimum size of other servers to check against. If not set, the default of 150 users is used. This

  TODO(james7132): Update this when the Discord Hotline integration is available. optional bool reject_hotline_reported_users = 3 [default = true];

NEXT ID: 2

Used in: Action

• optional StatusType type = 1

NEXT ID: 3

Used in: Action

• optional fixed64 channel_id = 1

• repeated fixed64 message_ids = 2

NEXT ID: 2

Used in: Action

• optional string content = 1

Used in: BotCommand

• optional uint64 channel_id = 1

• optional uint64 user_id = 2

• optional string content = 3

• optional uint64 timestamp = 4

Used in: MessageFilterRule.Criteria

• optional uint32 max_embed_count = 1

  The maximum number of unique embeds or attachments that can be included for the criteria to be met.

NEXT ID: 2

Used in: Action

• optional int64 amount = 1

  Required. Can be negative. If negative, will deescalate the user.

Used in: ModerationConfig

• repeated EscalationLadderRung rung = 1

Used in: EscalationLadder

• repeated Action action = 1

  Required: The actions to apply.

• optional string display_name = 2

  Required: The display name to show when listing out the ladder.

• optional uint64 deescalation_period = 3

  Optional: if set, after X period of time (in seconds), the user will be deescalated.

• optional EventSource source = 1

• repeated Action actions = 2

Used in: AutoConfig

• repeated MessageEvent on_message = 1

  Event: User sends or edits a message.

• repeated UserChangeEvent on_join = 2

• repeated UserChangeEvent on_leave = 3

• repeated UserChangeEvent on_ban = 4

• repeated UserChangeEvent on_verify = 5

Used in: Event

• optional uint64 guild_id = 1

• optional uint64 executor_user_id = 2

• optional uint64 authorizer_user_id = 3

• optional uint64 channel_id = 4

• optional uint64 timestamp = 5

• oneof details

  • BotCommand command = 6

Used in: MessageEvent, UserChangeEvent, UsernameVerificationConfig

• repeated string blacklist = 1

• repeated string whitelist = 2

• optional LoggingConfig logging = 1

• optional VerificationConfig verification = 2

• optional AutoConfig auto = 3

• optional ModerationConfig moderation = 4

• optional MusicConfig music = 5

• optional AnnouncementConfig announce = 6

• optional RoleConfig role = 7

Used in: MessageLoggingConfig

• repeated uint64 allowlist = 1

• repeated uint64 denylist = 2

NEXT ID: 1

Used in: Action

(message has no fields)

Used in: GuildConfig

• optional uint64 modlog_channel_id = 1

  Required. The channel to make modlog messages to.

• optional MessageLoggingConfig deleted_messages = 3

• optional MessageLoggingConfig edited_messages = 4

Used in: MessageFilterRule.Criteria

• optional MentionFilterCriteria.MentionLimits any_mention = 1

  Limits that apply to any mention, and uses the total number of mentions across all categories.

• optional MentionFilterCriteria.MentionLimits user_mention = 2

• optional MentionFilterCriteria.MentionLimits role_mention = 3

Used in: MentionFilterCriteria

• optional uint32 maximum_total = 1

  One of the following must be speciified. maximum_total: an upper limit uses the total raw count maximum_unique: an upper limit that uses the count of unique mentions.

• optional uint32 maximum_unique = 2

• oneof component

  • VerificationButton verification_button = 1

  • MusicButton music_button = 2

  • ActionButton action_button = 3

Used in: EventGroup

• repeated Action action = 1

• optional FilterSettings content_filter = 2

• optional MessageEvent.Type type = 3

• optional bool delete_message = 4

  Optional: if true, deletes the message after the EventResponses complete.

Used in: MessageEvent

• MESSAGE_CREATES = 1

• MESSAGE_EDITS = 2

• ALL_MESSAGES = 3

Used in: ModerationConfig

• repeated MessageFilterRule rules = 1

  Rules are applied in order and only one rule will apply to a given message. Either the first applicable rule will be applied or none will apply at all.

Used in: MessageFilterOptions

• optional string name = 1

  The name of the rule

• optional MessageFilterRule.Criteria criteria = 2

  Actually required. Criteria for triggering the rule.

• optional bool delete_message = 3

  If set to true (the default), the message will be deleted.

• optional bool notify_moderator = 4

  If set to true (the default), a moderator will be notified of the message via modlog.

• repeated Action additional_actions = 5

  Optional: additional actions to take on the author of the message. Actions are applied sequentially and will all be applied even if earlier actions are unsuccessful.

All of the following criteria are applied conjunctively, meaning all of them need to be satisfied for the rule to be used.

Used in: MessageFilterRule

• repeated string matches = 1

  A list of regexes. Triggers if any of them match the message content.

• optional bool includes_slurs = 2

  If set to true, triggers if the message content includes anything from a globally managed list of slurs.

• optional bool includes_invite_links = 3

  If set, triggers if the message includes a Discord invite link.

• optional bool exclude_moderators = 4

  If set to true, this exempts the user from the rule if the user is a moderator. Defaults to true.

• optional bool exclude_bots = 5

  If set to true, this exempts the user from the rule if the user is a bot. Defaults to true.

• repeated uint64 excluded_channels = 6

  Channel IDs where the rule does not apply.

• optional MentionFilterCriteria mentions = 7

  Triggers based on the number of mentions in a given message.

• optional EmbedFilterCriteria embeds = 8

  Triggers based on the embeds or attachments in a given message.

Used in: LoggingConfig

• optional bool enabled = 1

• optional uint64 output_channel_id = 2

• optional IdFilter channel_filter = 3

Used in: GuildConfig

• optional EscalationLadder escalation_ladder = 1

• optional MessageFilterOptions message_filter = 2

NEXT ID: 3

Used in: MessageComponentProto

• optional MusicUIType type = 1

• optional MusicButtonOption button_option = 2

NEXT ID: 8

Used in: MusicButton

• MUSIC_BUTTON_UNSPECIFIED = 0

• MUSIC_BUTTON_PLAY_PAUSE = 1

• MUSIC_BUTTON_STOP = 2

• MUSIC_BUTTON_NEXT_TRACK = 3

• MUSIC_BUTTON_QUEUE_NEXT_PAGE = 4

• MUSIC_BUTTON_QUEUE_PREV_PAGE = 5

• MUSIC_BUTTON_VOLUME_UP = 6

• MUSIC_BUTTON_VOLUME_DOWN = 7

Used in: GuildConfig

• optional uint32 volume = 1

  The volume the music bot operates at.

• repeated uint64 dj_role_id = 2

  DEPRECATED: Use RoleSettings.settings.permissions Optional: If set, people who can DJ the bot need to have this role. Otherwise, moderators by default have the permission.

• optional uint64 voice_channel_id = 3

  Optional: If set, the music bot wil only join that voice channel. Otherwise, the bot will join the first caller's current voice channel.

• repeated uint64 text_channel_id = 4

  Optional: If set, music commands will only work in the specified channels.

NEXT ID: 2

Used in: MusicStateProto

• repeated UserQueueProto user_queues = 1

NEXT ID: 8

• optional int64 position = 6

• repeated fixed64 skip_votes = 3

• optional MusicQueueProto queue = 4

NEXT ID: 3

Used in: MusicButton

• MUSIC_UI_TYPE_UNSPECIFIED = 0

• MUSIC_UI_TYPE_NOW_PLAYING = 1

• MUSIC_UI_TYPE_QUEUE = 2

NEXT ID: 2

Used in: Action

• optional StatusType type = 1

------------------------------------------------------------------------------ Role Configs ------------------------------------------------------------------------------

Used in: GuildConfig

• repeated uint64 self_serve_role_ids = 1

  DEPRECATED: Use setting.permissions Optional: The IDs of the roles that normal users can request whenever.

• map<uint64, RoleSettings> settings = 2

  Settings for each role, keyed by role ID

Used in: RoleConfig

• optional uint64 flags = 1

  Bitfield: 0 - DJ role 1 - Moderator 2 - Restorable

NEXT ID: 3

Used in: Action

• optional string content = 1

• optional uint64 channel_id = 2

Used in: ChangeRole, DeafenMember, MuteMember

• APPLY = 1

• UNAPPLY = 2

• TOGGLE = 3

NEXT ID: 8

Used in: UserQueueProto

• optional CachedUserProto requestor = 1

• optional string title = 2

• optional string author = 3

• optional string uri = 4

• optional uint64 length = 5

• optional bool is_stream = 6

• optional bytes track_data = 7

Used in: EventGroup

• repeated Action action = 1

• optional FilterSettings username_filter = 2

NEXT ID: 3

Used in: MusicQueueProto

• optional uint64 user_id = 1

• repeated TrackProto tracks = 2

Used in: VerificationConfig

• optional FilterSettings username_filter = 1

  Optional: The blacklist applies first. If any matches, the user is rejected, unless the any entry in the whitelist applies. Both are lists of regexes.

• optional bool reject_sexual_usernames = 2

• optional bool reject_offensive_usernames = 3

• optional bool reject_likely_user_bots = 4

NEXT ID: 3

Used in: MessageComponentProto

• optional VerificationButtonOption button_option = 1

• optional fixed64 user_id = 2

NEXT ID: 4

Used in: VerificationButton

• VERIFICATION_BUTTON_UNSPECIFIED = 0

• VERIFICATION_BUTTON_VERIFY = 1

• VERIFICATION_BUTTON_KICK = 2

• VERIFICATION_BUTTON_BAN = 3

Used in: GuildConfig

• optional bool enabled = 1

  If set to true, verification as a whole is enabled.

• optional uint64 role_id = 2

  Optional: The role to use for verification. If not set, no role will be given.

• optional uint64 kick_unvalidated_users_after = 3

  Optional: If set, unvalildated users are kicked after the number of seconds passes. Minimum value is 1 hour (3600 seconds).

• optional uint64 minimum_account_age = 4

  Optional: If set, accounts under the age, in seconds, will be rejected.

• optional bool ping_moderator_on_fail = 8

  If true (the default), pings a moderator upon failing to verify a new join.

• optional uint64 lockdown_expiration = 9

  Unix time for lifting a lockdown. If the time has already passed or if it's not present, the server is no longer under lockdown.

• optional AvatarVerificationConfig avatar = 5

  Optional: aspect specific configurations. If not set, the default values are used.

• optional UsernameVerificationConfig username = 6

• optional CrossGuildVerificationConfig cross_server = 7