package raw
Type Members
- case class PartialRawGuildMember(nick: Option[String], avatar: Option[String], roles: Seq[RoleId], joinedAt: Option[OffsetDateTime], premiumSince: Option[OffsetDateTime], deaf: Boolean, mute: Boolean, pending: Option[Boolean], communicationDisabledUntil: Option[OffsetDateTime]) extends Product with Serializable
Represents a user in a guild, without the user field.
Represents a user in a guild, without the user field.
- nick
The nickname of this user in this guild.
- roles
The roles of this user.
- joinedAt
When this user joined the guild.
- premiumSince
When this user boosted the server.
- deaf
If this user is deaf.
- mute
IF this user is mute.
- pending
True if the member hasn't gotten past the guild screening yet
- case class PartialUser(id: UserId, username: Option[String], discriminator: Option[String], avatar: Option[String], bot: Option[Boolean], system: Option[Boolean], mfaEnabled: Option[Boolean], banner: Option[String], accentColor: Option[Int], locale: Option[String], verified: Option[Boolean], email: Option[String], flags: Option[UserFlags], premiumType: Option[PremiumType], publicFlags: Option[UserFlags]) extends Product with Serializable
A user where fields can be missing.
A user where fields can be missing.
- id
The id of the user.
- username
The name of the user.
- discriminator
The discriminator for the user. Those four last digits when clicking in a users name.
- avatar
The users avatar hash.
- bot
If this user belongs to a OAuth2 application.
- system
If the user is part of Discord's urgent messaging system.
- mfaEnabled
If this user has two factor authentication enabled.
- banner
The user's banner image hash.
- accentColor
The user's banner color as an RGB int.
- locale
The user's chosen language.
- verified
If this user is verified. Requires the email OAuth scope.
The users email. Requires the email OAuth scope.
- flags
The flags on a user's account.
- premiumType
The type of nitro the account has.
- publicFlags
The public flags on a user's account.
- case class RawActivity(name: String, type: ActivityType, url: Option[String], createdAt: Instant, timestamps: Option[ActivityTimestamps], applicationId: Option[ApplicationId], details: Option[String], state: Option[String], emoji: Option[ActivityEmoji], party: Option[RawActivityParty], assets: Option[ActivityAsset], secrets: Option[ActivitySecrets], instance: Option[Boolean], flags: Option[ActivityFlags], buttons: Option[Seq[String]]) extends Product with Serializable
The content of a presence.
The content of a presence.
- name
The text show.
- url
A uri if the type is streaming.
- timestamps
Timestamps for start and end of activity.
- applicationId
Application id of the game.
- details
What the player is doing.
- state
The user's party status.
- party
Info about the user's party.
- assets
Images for the presence and hover texts.
- secrets
Secrets for rich presence joining and spectating.
- instance
If the activity is an instanced game session.
- flags
Indicates what the payload includes
- buttons
Custom buttons shown for the rich presence
- case class RawActivityParty(id: Option[String], size: Option[Seq[Int]]) extends Product with Serializable
- id
The id of the party.
- size
Sequence of two integers, the current size, and the max size.
- case class RawBan(reason: Option[String], user: User) extends Product with Serializable
A raw ban before going through the cache.
A raw ban before going through the cache.
- reason
Why the user was banned.
- user
The user that was baned.
- case class RawChannel(id: ChannelId, type: ChannelType, guildId: Option[GuildId], position: Option[Int], permissionOverwrites: Option[Seq[PermissionOverwrite]], name: Option[String], topic: Option[String], nsfw: Option[Boolean], lastMessageId: Option[MessageId], bitrate: Option[Int], userLimit: Option[Int], rateLimitPerUser: Option[Int], recipients: Option[Seq[User]], icon: Option[String], ownerId: Option[UserId], applicationId: Option[ApplicationId], parentId: Option[GuildChannelId], lastPinTimestamp: Option[OffsetDateTime], rtcRegion: Option[String], videoQualityMode: Option[VideoQualityMode], messageCount: Option[Int], memberCount: Option[Int], threadMetadata: Option[RawThreadMetadata], member: Option[RawThreadMember], defaultAutoArchiveDuration: Option[Int]) extends Product with Serializable
A raw channel before going through the cache.
A raw channel before going through the cache.
- id
The channel id.
- guildId
The guildId this channel belongs to if it's a guild channel.
- position
The position of this channel if it's a guild channel.
- permissionOverwrites
The permission overwrites of this channel if it's a guild channel.
- name
The name of this channel if it's a guild channel.
- topic
The topic of this channel if it's a guild voice channel.
- nsfw
If this channel is NSFW if it's a guild channel.
- lastMessageId
The last message id if it's a text channel. The id may be invalid.
- bitrate
The bitrate of this channel if it's a guild voice channel.
- userLimit
The user limit of this channel if it's a guild voice channel.
- rateLimitPerUser
The amount of time a user has to wait before sending messages after each other. Bots are not affected.
- recipients
The recipients of this channel if it's a group DM channel.
- icon
The icon of this channel if it has one.
- ownerId
The owner of this channel if it's a DM or group DM channel.
- applicationId
The application id of this channel if it's a guild channel.
- parentId
The category of this channel if it's a guild channel.
- rtcRegion
Channel region to use. Automatic if none.
- messageCount
Approximate amount of messages in a thread. Stops at 50.
- memberCount
Approximate amount of members in a thread. Stops at 50.
- threadMetadata
Thread specific data.
- member
Info about the current member for a thread.
- defaultAutoArchiveDuration
The default for when a newly created thread is auto archived in minutes.
- case class RawEmoji(id: EmojiId, name: String, roles: Seq[RoleId], user: Option[User], requireColons: Option[Boolean], managed: Option[Boolean], animated: Option[Boolean], available: Option[Boolean]) extends Product with Serializable
A raw emoji before going through the cache.
A raw emoji before going through the cache.
- id
The id of the emoji.
- name
The emoji name.
- roles
The roles that can use this emoji.
- user
The user that created this emoji.
- requireColons
If the emoji requires colons.
- managed
If the emoji is managed.
- available
If the emoji can be used.
- case class RawGuild(id: GuildId, name: String, icon: Option[String], iconHash: Option[String], splash: Option[String], discoverySplash: Option[String], owner: Option[Boolean], ownerId: UserId, permissions: Option[Permission], afkChannelId: Option[NormalVoiceGuildChannelId], afkTimeout: Int, verificationLevel: VerificationLevel, defaultMessageNotifications: NotificationLevel, explicitContentFilter: FilterLevel, roles: Seq[RawRole], emojis: Seq[RawEmoji], features: Seq[GuildFeature], mfaLevel: MFALevel, applicationId: Option[ApplicationId], widgetEnabled: Option[Boolean], widgetChannelId: Option[GuildChannelId], systemChannelId: Option[TextGuildChannelId], systemChannelFlags: SystemChannelFlags, rulesChannelId: Option[TextGuildChannelId], joinedAt: Option[OffsetDateTime], large: Option[Boolean], unavailable: Option[Boolean], memberCount: Option[Int], voiceStates: Option[Seq[VoiceState]], members: Option[Seq[RawGuildMember]], channels: Option[Seq[RawChannel]], threads: Option[Seq[RawChannel]], presences: Option[Seq[RawPresence]], maxPresences: Option[Int], maxMembers: Option[Int], vanityUrlCode: Option[String], description: Option[String], banner: Option[String], premiumTier: PremiumTier, premiumSubscriptionCount: Option[Int], preferredLocale: Option[String], publicUpdatesChannelId: Option[TextGuildChannelId], maxVideoChannelUsers: Option[Int], approximateMemberCount: Option[Int], approximatePresenceCount: Option[Int], welcomeScreen: Option[WelcomeScreen], nsfwLevel: NSFWLevel, stageInstances: Option[Seq[StageInstance]], stickers: Option[Seq[RawSticker]], guildScheduledEvents: Option[Seq[GuildScheduledEvent]], premiumProgressBarEnabled: Boolean) extends Product with Serializable
A raw guild before going through the cache.
A raw guild before going through the cache.
- id
The id of the guild.
- name
The name of the guild.
- icon
The icon hash.
- iconHash
Used for template objects.
- splash
The splash hash.
- discoverySplash
The discovery splash hash.
- owner
If the current user is the owner of the guild.
- ownerId
The userId of the owner.
- permissions
The permissions of the current user without overwrites.
- afkChannelId
The channelId of the AFK channel.
- afkTimeout
The amount of seconds you need to be AFK before being moved to the AFK channel.
- verificationLevel
The verification level for the guild.
- defaultMessageNotifications
The notification level for the guild.
- explicitContentFilter
The explicit content filter level for the guild.
- roles
The roles of the guild.
- emojis
The emojis of the guild.
- features
The enabled guild features.
- mfaLevel
The MFA level.
- applicationId
The application id if this guild is bot created.
- widgetEnabled
If the widget is enabled.
- widgetChannelId
The channel id for the widget.
- systemChannelId
The channel which notices like welcome and boost messages are sent to.
- systemChannelFlags
The flags for the system channel
- rulesChannelId
The id for the channel where the rules of a guild are stored.
- joinedAt
When the client joined the guild.
- large
If this guild is above the large threshold.
- memberCount
The amount of members in the guild.
- voiceStates
The voice states of the guild.
- members
The guild members in the guild.
- channels
The channels in the guild.
- presences
The presences in the guild.
- maxPresences
The maximum amount of presences in the guild.
- maxMembers
The maximum amount of members in the guild.
- vanityUrlCode
The vanity url code for the guild.
- description
A descriptiom fpr the guild.
- banner
A banner hash for the guild.
- premiumTier
The premium tier of the guild.
- premiumSubscriptionCount
How many users that are boosting the server.
- preferredLocale
The preferred locale of a community guild.
- publicUpdatesChannelId
The channel where admin and mods can see public updates are sent to public guilds.
- maxVideoChannelUsers
The max amount of users in a video call.
- approximateMemberCount
Roughly how many members there is in the guild.
- approximatePresenceCount
Roughly how many presences there is in the guild.
- welcomeScreen
The welcome screen shown to new members. Only returned in invite objects.
- nsfwLevel
The guild NSFW level.
- case class RawGuildMember(user: User, avatar: Option[String], nick: Option[String], roles: Seq[RoleId], joinedAt: Option[OffsetDateTime], premiumSince: Option[OffsetDateTime], deaf: Boolean, mute: Boolean, pending: Option[Boolean], communicationDisabledUntil: Option[OffsetDateTime]) extends Product with Serializable
Represents a user in a guild.
Represents a user in a guild.
- user
The user of this member.
- nick
The nickname of this user in this guild.
- roles
The roles of this user.
- joinedAt
When this user joined the guild.
- premiumSince
When this user boosted the server.
- deaf
If this user is deaf.
- mute
IF this user is mute.
- pending
True if the member hasn't gotten past the guild screening yet
- case class RawMessage(id: MessageId, channelId: TextChannelId, guildId: Option[GuildId], author: Author[_], member: Option[PartialRawGuildMember], content: String, timestamp: OffsetDateTime, editedTimestamp: Option[OffsetDateTime], tts: Boolean, mentionEveryone: Boolean, mentions: Seq[User], mentionRoles: Seq[RoleId], mentionChannels: Option[Seq[ChannelMention]], attachments: Seq[Attachment], embeds: Seq[ReceivedEmbed], reactions: Option[Seq[Reaction]], nonce: Option[Either[Long, String]], pinned: Boolean, type: MessageType, activity: Option[RawMessageActivity], application: Option[PartialApplication], applicationId: Option[ApplicationId], messageReference: Option[MessageReference], flags: Option[MessageFlags], stickers: Option[Seq[RawSticker]], stickerItems: Option[Seq[StickerItem]], referencedMessage: Option[RawMessage], interaction: Option[MessageInteraction], components: Option[Seq[ActionRow]], thread: Option[RawChannel]) extends Product with Serializable
A raw message before going through the cache.
A raw message before going through the cache.
- id
The id of the message.
- channelId
The channel this message was sent to.
- guildId
The guild this message was sent to. Can me missing.
- author
The author that sent this message.
- member
The guild member user that sent this message. Can be missing.
- content
The content of this message.
- timestamp
The timestamp this message was created.
- editedTimestamp
The timestamp this message was last edited.
- tts
If this message is has text-to-speech enabled.
- mentionEveryone
If this message mentions everyone.
- mentions
All the users this message mentions.
- mentionRoles
All the roles this message mentions.
- mentionChannels
Potentially channels mentioned in the message. Only used for cross posted public channels so far.
- attachments
All the attachments of this message.
- embeds
All the embeds of this message.
- reactions
All the reactions on this message.
- nonce
A nonce for this message.
- pinned
If this message is pinned.
- activity
Sent with rich presence chat embeds.
- application
Sent with rich presence chat embeds.
- applicationId
If an message is a response to an interaction, then this is the id of the interaction's application.
- messageReference
Data sent with a crossposts and replies.
- flags
Extra features of the message.
- stickers
Stickers sent with the message.
- referencedMessage
Message associated with the message reference.
- interaction
Sent if the message is a response to an Interaction.
- case class RawMessageActivity(type: MessageActivityType, partyId: Option[String]) extends Product with Serializable
- type
Activity type.
- partyId
Party id from rich presence.
- case class RawPresence(user: PartialUser, status: Option[PresenceStatus], activities: Option[Seq[RawActivity]], clientStatus: Option[ClientStatus]) extends Product with Serializable
A raw presence.
A raw presence.
- user
A partial user.
- status
The presence status.
- case class RawRole(id: RoleId, name: String, icon: Option[String], unicodeEmoji: Option[String], color: Int, hoist: Boolean, position: Int, permissions: Permission, managed: Boolean, mentionable: Boolean, tags: Option[RoleTags]) extends Product with Serializable
A raw role before going through the cache.
A raw role before going through the cache.
- id
The id of this role.
- name
The name of this role.
- icon
Optional icon of this role.
- unicodeEmoji
Optional emoji of this role.
- color
The color of this role.
- hoist
If this role is listed in the sidebar.
- position
The position of this role.
- permissions
The permissions this role grant.
- managed
If this is a bot role.
- mentionable
If you can mention this role.
- case class RawSticker(id: StickerId, packId: Option[SnowflakeType[StickerPack]], name: String, description: Option[String], tags: Option[String], type: StickerType, formatType: FormatType, available: Option[Boolean], guildId: Option[GuildId], user: Option[User], sortValue: Option[Int]) extends Product with Serializable
The structure of a sticker sent in a message in it's raw form.
The structure of a sticker sent in a message in it's raw form.
- id
Id of the sticker.
- packId
Id of the pack the sticker is from.
- name
Name of the sticker.
- description
Description of the sticker.
- tags
A comma-separated list of tags for the sticker.
- formatType
Type of sticker format.
- available
If this guild sticker can currently be used.
- guildId
Id of the guild that owns this sticker.
- user
The user that uploaded the sticker.
- sortValue
A standard sticker's sort value in it's pack.
- case class RawThreadMember(id: Option[ThreadGuildChannelId], userId: Option[UserId], joinTimestamp: OffsetDateTime, flags: Int) extends Product with Serializable
Indicates if and when a user has joined a thread.
Indicates if and when a user has joined a thread.
- id
Id of the thread.
- userId
Id of the user.
- joinTimestamp
When the user joined the thread.
- flags
User specific thread settings.
- case class RawThreadMetadata(archived: Boolean, autoArchiveDuration: Int, archiveTimestamp: OffsetDateTime, locked: Boolean, invitable: Option[Boolean]) extends Product with Serializable
Thread specific info.
Thread specific info.
- archived
If the thread is archived.
- autoArchiveDuration
How long in minutes until the thread will be auto archived.
- archiveTimestamp
When the thread's archive status was last changed
- locked
If the thread is locked.