data

Type Members

sealed trait Activity extends AnyRef

The text in a presence
case class ActivityAsset(largeImage: Option[String], largeText: Option[String], smallImage: Option[String], smallText: Option[String]) extends Product with Serializable

largeImage
Id for the large asset. Usually a snowflake.
largeText
Text displayed when hovering over the large image.
smallImage
Id for the small asset. Usually a snowflake.
smallText
Text displayed when hovering over the small image.
case class ActivityParty(id: Option[String], currentSize: Option[Int], maxSize: Option[Int]) extends Product with Serializable

id
The id of the party
currentSize
The current size of the party.
maxSize
The max size of the party.
case class ActivityTimestamps(start: Option[Instant], end: Option[Instant]) extends Product with Serializable

start
When the activity started.
end
When the activity will end.
case class Attachment(id: SnowflakeType[Attachment], filename: String, size: Int, url: String, proxyUrl: String, height: Option[Int], width: Option[Int]) extends Product with Serializable

An attachment for a message
An attachment for a message
id
The id of the attachment
filename
The filename of the attachment
size
The file size in bytes
url
The url of the attachment
proxyUrl
The proxyUrl of the attachment
height
The height of the attachment if it's an image
width
The width of the attachment if it's an image
case class AuditLog(webhooks: Seq[Webhook], users: Seq[User], auditLogEntries: Seq[AuditLogEntry]) extends Product with Serializable

Root audit log object.
Root audit log object. Received from net.katsstuff.ackcord.http.rest.GetGuildAuditLog
webhooks
The webhooks found in the log
users
The users found in the log
auditLogEntries
The entries of the log
sealed trait AuditLogChange[A] extends AnyRef

Some sort of change
Some sort of change
A
The data type that changed
case class AuditLogEntry(targetId: Option[RawSnowflake], changes: Option[Seq[AuditLogChange[_]]], userId: UserId, id: RawSnowflake, actionType: AuditLogEvent, options: Option[OptionalAuditLogInfo], reason: Option[String]) extends Product with Serializable

An individual audit log event
An individual audit log event
targetId
The id of the affected object
changes
The changes made to the object
userId
The user responsible for the changes
id
The id of this entry
actionType
Type of change that happened
options
Optional extra data for some changes, see comments on OptionalAuditLogInfo for more info
reason
The reason for the change
sealed trait AuditLogEvent extends AnyRef

A type of change that an entry can represent
sealed trait Author[A] extends AnyRef

A author of a message.
A author of a message. While a message is normally sent by a User, it can also be sent by a WebhookAuthor.
case class Ban(reason: Option[String], user: UserId) extends Product with Serializable

Represents a banned user.
Represents a banned user.
reason
Why the user was banned.
user
The user that was baned.
sealed trait Channel extends AnyRef

Base channel type
type ChannelId = Long with Tagged[SnowflakeTag[Channel]]
implicit final class ChannelIdSyntax extends AnyVal
sealed trait ChannelType extends AnyRef

Different type of channels
case class Connection(id: String, name: String, type: String, revoked: Boolean, integrations: Seq[Integration]) extends Product with Serializable

A connection that a user has attached.
A connection that a user has attached.
id
The id of the connection.
name
The name of the connection.
revoked
If the connection has been revoked.
integrations
Integrations of the connection.
case class DMChannel(id: ChannelId, lastMessageId: Option[MessageId], userId: UserId) extends Channel with TChannel with GetUser with Product with Serializable

A DM text channel
trait DiscordProtocol extends AnyRef
case class EmbedField(name: String, value: String, inline: Option[Boolean] = None) extends Product with Serializable

A field for an embed
A field for an embed
name
The name or title of the field.
value
The value or text of the field
inline
If the field is rendered inline.
case class Emoji(id: EmojiId, name: String, roles: Seq[RoleId], userId: Option[UserId], requireColons: Boolean, managed: Boolean, animated: Boolean) extends Product with Serializable

An emoji in a guild.
An emoji in a guild.
id
The id of the emoji.
name
The emoji name.
roles
The roles that can use this emoji.
userId
The id of the user that created this emoji.
requireColons
If the emoji requires colons.
managed
If the emoji is managed.
type EmojiId = Long with Tagged[SnowflakeTag[Emoji]]
implicit final class EmojiIdSyntax extends AnyVal
trait FilterLevel extends AnyRef

The different explicit content filter levels to use for a guild.
trait GetGuild extends AnyRef
trait GetGuildOpt extends AnyRef
trait GetTChannel extends AnyRef
trait GetUser extends AnyRef
trait GetVChannelOpt extends AnyRef
case class GroupDMChannel(id: ChannelId, name: String, users: Seq[UserId], lastMessageId: Option[MessageId], ownerId: UserId, applicationId: Option[RawSnowflake], icon: Option[String]) extends Channel with TChannel with Product with Serializable

A group DM text channel
A group DM text channel
users
The users in this group DM
ownerId
The creator of this channel
applicationId
The applicationId of the application that created this channel, if the channel wasn't created by a user
icon
The icon hash for this group dm
case class Guild(id: GuildId, name: String, icon: Option[String], splash: Option[String], owner: Option[Boolean], ownerId: UserId, permissions: Option[Permission], region: String, afkChannelId: Option[ChannelId], afkTimeout: Int, embedEnabled: Option[Boolean], embedChannelId: Option[ChannelId], verificationLevel: VerificationLevel, defaultMessageNotifications: NotificationLevel, explicitContentFilter: FilterLevel, roles: SnowflakeMap[Role, Role], emojis: SnowflakeMap[Emoji, Emoji], features: Seq[String], mfaLevel: MFALevel, applicationId: Option[RawSnowflake], widgetEnabled: Option[Boolean], widgetChannelId: Option[ChannelId], systemChannelId: Option[ChannelId], joinedAt: OffsetDateTime, large: Boolean, memberCount: Int, voiceStates: SnowflakeMap[User, VoiceState], members: SnowflakeMap[User, GuildMember], channels: SnowflakeMap[Channel, GuildChannel], presences: SnowflakeMap[User, Presence]) extends UnknownStatusGuild with Product with Serializable

A guild or server in Discord.
A guild or server in Discord.
id
The id of the guild.
name
The name of the guild.
icon
The icon hash.
splash
The 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.
region
The voice region
afkChannelId
The channelId of the AFK channel.
afkTimeout
The amount of seconds you need to be AFK before being moved to the AFK channel.
embedEnabled
If the embed is enabled.
embedChannelId
The channelId for the embed.
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 system messages are sent to.
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.
case class GuildCategory(id: ChannelId, guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRoleTag, PermissionOverwrite], nsfw: Boolean, parentId: Option[ChannelId]) extends GuildChannel with Product with Serializable

A category in a guild
sealed trait GuildChannel extends Channel with GetGuild

A channel within a guild
case class GuildEmbed(enabled: Boolean, channelId: Option[ChannelId]) extends Product with Serializable
type GuildId = Long with Tagged[SnowflakeTag[Guild]]
implicit final class GuildIdSyntax extends AnyVal
case class GuildMember(userId: UserId, guildId: GuildId, nick: Option[String], roleIds: Seq[RoleId], joinedAt: OffsetDateTime, deaf: Boolean, mute: Boolean) extends GetUser with GetGuild with Product with Serializable

Represents a user in a guild.
Represents a user in a guild.
userId
The user of this member.
guildId
The guild this member belongs to.
nick
The nickname of this user in this guild.
roleIds
The roles of this user.
joinedAt
When this user joined the guild.
deaf
If this user is deaf.
mute
IF this user is mute.
final class ImageData extends AnyVal
sealed trait ImageFormat extends AnyRef
case class Integration(id: IntegrationId, name: String, type: String, enabled: Boolean, syncing: Boolean, roleId: RoleId, expireBehavior: Int, expireGracePeriod: Int, user: User, account: IntegrationAccount, syncedAt: OffsetDateTime) extends Product with Serializable

A server integration
A server integration
id
The id of the integration
name
The integration name
enabled
If the integration is enabled
syncing
If the integration is synced
roleId
Role that this integration uses for subscribers
expireBehavior
The behavior of expiring subscribers.
expireGracePeriod
The grace period before expiring subscribers.
user
The user for this integration
account
Account information
syncedAt
When the integration last synced
case class IntegrationAccount(id: String, name: String) extends Product with Serializable

id
The id of the account
name
The name of the account
type IntegrationId = Long with Tagged[SnowflakeTag[Integration]]
case class Invite(code: String, guild: InviteGuild, channel: InviteChannel, approximatePresenceCount: Option[Int], approximateMemberCount: Option[Int]) extends Product with Serializable

A simple invite.
A simple invite.
code
An invite code.
guild
The guild the invite is for.
channel
The channel the invite is for.
approximatePresenceCount
Approximate amount of people online.
approximateMemberCount
Approximate amount of total members.
case class InviteChannel(id: ChannelId, name: String, type: ChannelType) extends Product with Serializable

A partial channel with the information used by an invite
A partial channel with the information used by an invite
id
The channel id
name
The channel name
case class InviteGuild(id: GuildId, name: String, splash: Option[String], icon: Option[String]) extends Product with Serializable

A partial guild with the information used by an invite
A partial guild with the information used by an invite
id
The guild id
name
The guild name
splash
The guild splash hash
icon
The guild icon hash
case class InviteWithMetadata(code: String, guild: InviteGuild, channel: InviteChannel, inviter: User, uses: Int, maxUses: Int, maxAge: Int, temporary: Boolean, createdAt: OffsetDateTime, revoked: Boolean) extends Product with Serializable

An invite with extra information.
An invite with extra information.
code
An invite code.
guild
The guild the invite is for.
channel
The channel the invite is for.
inviter
The user that created the invite.
uses
How many times the invite has been used.
maxUses
How many times this invite can be used.
maxAge
The duration in seconds when the invite will expire
temporary
If this invite is temporary
createdAt
When this invite was created
revoked
If this invite has been revoked
trait MFALevel extends AnyRef
case class Message(id: MessageId, channelId: ChannelId, guildId: Option[GuildId], authorId: RawSnowflake, isAuthorUser: Boolean, member: Option[GuildMember], content: String, timestamp: OffsetDateTime, editedTimestamp: Option[OffsetDateTime], tts: Boolean, mentionEveryone: Boolean, mentions: Seq[UserId], mentionRoles: Seq[RoleId], attachment: Seq[Attachment], embeds: Seq[ReceivedEmbed], reactions: Seq[Reaction], nonce: Option[RawSnowflake], pinned: Boolean, messageType: MessageType, activity: Option[MessageActivity], application: Option[MessageApplication]) extends GetTChannel with Product with Serializable

A message sent to a channel.
A message sent to a channel.
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.
authorId
The id of the author that sent this message.
isAuthorUser
If the author of this message was a user.
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.
attachment
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.
messageType
The message type
case class MessageActivity(activityType: MessageActivityType, partyId: Option[String]) extends Product with Serializable

activityType
Activity type.
partyId
Party id from rich presence.
sealed trait MessageActivityType extends AnyRef
case class MessageApplication(id: RawSnowflake, coverImage: String, description: String, icon: String, name: String) extends Product with Serializable

id
Id of the application
coverImage
Id of the embeds image asset
description
Description of the application
icon
Id of icon of the application
name
Name of the application
type MessageId = Long with Tagged[SnowflakeTag[Message]]
implicit final class MessageIdSyntax extends AnyVal
trait MessageType extends AnyRef

An enum of all the different message types.
trait NotificationLevel extends AnyRef

The different notification levels that can be used for a guild
case class OptionalAuditLogInfo(deleteMemberDays: Option[String], membersRemoved: Option[String], channelId: Option[ChannelId], count: Option[String], id: Option[UserOrRoleId], type: Option[PermissionOverwriteType], roleName: Option[String]) extends Product with Serializable

Extra data for an entry
Extra data for an entry
deleteMemberDays
The amount of days before a user was considered inactive and kicked. Present for MemberPrune.
membersRemoved
The amount of members removed. Present for MemberPrune.
channelId
The channelId of the deleted message. Present for MessageDelete.
count
The amount of deleted messages. Present for MessageDelete.
id
The id of the overwritten object. Present for overwrite events.
roleName
The name of the role. Present for overwrite events if type == Role.
case class OutgoingEmbed(title: Option[String] = None, description: Option[String] = None, url: Option[String] = None, timestamp: Option[OffsetDateTime] = None, color: Option[Int] = None, footer: Option[OutgoingEmbedFooter] = None, image: Option[OutgoingEmbedImage] = None, video: Option[OutgoingEmbedVideo] = None, thumbnail: Option[OutgoingEmbedThumbnail] = None, author: Option[OutgoingEmbedAuthor] = None, fields: Seq[EmbedField] = Seq.empty) extends Product with Serializable

An outgoing embed.
An outgoing embed.
title
The title of the embed.
description
The embed description or main text.
url
The url of the embed.
timestamp
The timestamp of the embed.
color
The color of the embed
footer
The footer part of the embed.
image
The image part of the embed.
thumbnail
The thumbnail part of the embed.
author
The author part of the embed.
fields
The fields of the embed.
case class OutgoingEmbedAuthor(name: String, url: Option[String] = None, iconUrl: Option[String] = None) extends Product with Serializable

The author part of an outgoing embed
The author part of an outgoing embed
name
The name of the author
url
The url to link when clicking on the author
iconUrl
The icon to show besides the author.
case class OutgoingEmbedFooter(text: String, iconUrl: Option[String] = None) extends Product with Serializable

The footer part of an outgoing embed.
The footer part of an outgoing embed.
text
The text of the footer
iconUrl
The icon url of the footer.
case class OutgoingEmbedImage(url: String) extends Product with Serializable

The image part of an outgoing embed.
The image part of an outgoing embed.
url
The url to the image.
case class OutgoingEmbedThumbnail(url: String) extends Product with Serializable

The thumbnail part of an outgoing embed.
The thumbnail part of an outgoing embed.
url
The url to the thumbnail.
case class OutgoingEmbedVideo(url: String) extends Product with Serializable

The video part of an outgoing embed.
The video part of an outgoing embed.
url
The url to the video.
case class PartialEmoji(id: Option[EmojiId], name: String) extends Product with Serializable

A partial emoji found in reactions
A partial emoji found in reactions
id
The id of the emoji. If it's absent, it's not a guild emoji.
name
The name of the emoji.
type Permission = Long with Tagged[Permission.type]

A permission to do some action.
A permission to do some action. In AckCord this is represented as a value class around int.
case class PermissionOverwrite(id: UserOrRoleId, type: PermissionOverwriteType, allow: Permission, deny: Permission) extends Product with Serializable

Represents a permission overwrite in a channel for a user or a guild.
Represents a permission overwrite in a channel for a user or a guild.
id
The id that this overwrite applies to. Can be both a user or a role. Check `type` to see what is valid for this overwrite.
allow
The permissions granted by this overwrite.
deny
The permissions denied by this overwrite.
sealed trait PermissionOverwriteType extends AnyRef

Permission overwrites can apply to both users and role.
Permission overwrites can apply to both users and role. This tells you what's being overwritten for a specific overwrite.
implicit final class PermissionSyntax extends AnyVal
case class Presence(userId: UserId, activity: Option[Activity], status: PresenceStatus) extends GetUser with Product with Serializable

The presence for a user
The presence for a user
userId
The user id
activity
The activity of the presence
status
The status of the user
case class PresenceGame(name: String, timestamps: Option[ActivityTimestamps], applicationId: Option[RawSnowflake], details: Option[String], state: Option[String], party: Option[ActivityParty], assets: Option[ActivityAsset]) extends Activity with Product with Serializable

The presence of someone playing a game
The presence of someone playing a game
applicationId
Application id of the game.
state
The user's party status.
party
Info about the user's party.
case class PresenceListening(name: String, timestamps: Option[ActivityTimestamps], details: Option[String], assets: Option[ActivityAsset]) extends Activity with Product with Serializable

The presence of someone listening to music
sealed trait PresenceStatus extends AnyRef

The different statuses a user can have
case class PresenceStreaming(name: String, uri: Option[String], timestamps: Option[ActivityTimestamps], applicationId: Option[RawSnowflake], details: Option[String], state: Option[String], party: Option[ActivityParty], assets: Option[ActivityAsset]) extends Activity with Product with Serializable

The presence of someone streaming
The presence of someone streaming
uri
The uri of the stream
applicationId
Application id of the game.
state
The user's party status.
party
Info about the user's party.
type RawSnowflake = Long with Tagged[SnowflakeTag[RawSnowflakeTag]]
sealed trait RawSnowflakeTag extends AnyRef
case class Reaction(count: Int, me: Boolean, emoji: PartialEmoji) extends Product with Serializable

A reaction to a message
A reaction to a message
count
The amount of people that have reacted with this emoji.
me
If the client has reacted with this emoji.
emoji
The emoji of the reaction.
case class ReceivedEmbed(title: Option[String], type: Option[String], description: Option[String], url: Option[String], timestamp: Option[OffsetDateTime], color: Option[Int], footer: Option[ReceivedEmbedFooter], image: Option[ReceivedEmbedImage], thumbnail: Option[ReceivedEmbedThumbnail], video: Option[ReceivedEmbedVideo], provider: Option[ReceivedEmbedProvider], author: Option[ReceivedEmbedAuthor], fields: Option[Seq[EmbedField]]) extends Product with Serializable

A received embed.
A received embed.
title
The title of the embed.
description
The embed description or main text.
url
The url of the embed.
timestamp
The timestamp of the embed.
color
The color of the embed
footer
The footer part of the embed.
image
The image part of the embed.
thumbnail
The thumbnail part of the embed.
video
The video part of the embed.
provider
The provider part of the embed.
author
The author part of the embed.
fields
The fields of the embed.
case class ReceivedEmbedAuthor(name: Option[String], url: Option[String], iconUrl: Option[String], proxyIconUrl: Option[String]) extends Product with Serializable

The author part of a received embed.
The author part of a received embed.
name
The author name
url
An url for the author text.
iconUrl
An icon url for the author.
proxyIconUrl
A proxy url for the icon.
case class ReceivedEmbedFooter(text: String, iconUrl: Option[String], proxyIconUrl: Option[String]) extends Product with Serializable

The footer part of a received embed.
The footer part of a received embed.
text
The footer text.
iconUrl
An icon url for the footer.
proxyIconUrl
A proxy url for the footer.
case class ReceivedEmbedImage(url: Option[String], proxyUrl: Option[String], height: Option[Int], width: Option[Int]) extends Product with Serializable

The image part of a received embed.
The image part of a received embed.
url
The url of the image.
proxyUrl
The proxy url of the image.
height
The height of the image.
width
The width of the image.
case class ReceivedEmbedProvider(name: Option[String], url: Option[String]) extends Product with Serializable

The provider part of a received embed.
The provider part of a received embed.
name
The name of the provider.
url
The url of a provider.
case class ReceivedEmbedThumbnail(url: Option[String], proxyUrl: Option[String], height: Option[Int], width: Option[Int]) extends Product with Serializable

The thumbnail part of a received embed.
The thumbnail part of a received embed.
url
The url to the thumbnail.
proxyUrl
The proxy url of the thumbnail.
height
The height of the thumbnail.
width
The width of the thumbnail.
case class ReceivedEmbedVideo(url: Option[String], height: Option[Int], width: Option[Int]) extends Product with Serializable

The video part of a received embed.
The video part of a received embed.
url
The url of the video.
height
The height of the video.
width
The width of the video.
case class Role(id: RoleId, guildId: GuildId, name: String, color: Int, hoist: Boolean, position: Int, permissions: Permission, managed: Boolean, mentionable: Boolean) extends GetGuild with Product with Serializable

A role in a guild.
A role in a guild.
id
The id of this role.
guildId
The guildId this role belongs to.
name
The name 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.
type RoleId = Long with Tagged[SnowflakeTag[Role]]
implicit final class RoleIdSyntax extends AnyVal
sealed trait SnowflakeTag[+A] extends AnyRef
type SnowflakeType[A] = Long with Tagged[SnowflakeTag[A]]
implicit final class SnowflakeTypeSyntax[A] extends AnyVal
sealed trait TChannel extends Channel

A text channel that has text messages
case class TGuildChannel(id: ChannelId, guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRoleTag, PermissionOverwrite], topic: Option[String], lastMessageId: Option[MessageId], rateLimitPerUser: Option[Int], nsfw: Boolean, parentId: Option[ChannelId], lastPinTimestamp: Option[OffsetDateTime]) extends GuildChannel with TChannel with Product with Serializable

A text channel in a guild
A text channel in a guild
rateLimitPerUser
The amount of time a user has to wait before sending messages after each other. Bots are not affected.
case class UnavailableGuild(id: GuildId, unavailable: Boolean) extends UnknownStatusGuild with Product with Serializable

A guild which is not available.
A guild which is not available.
id
The id of the guild.
unavailable
If the guild is unavailable.
sealed trait UnknownStatusGuild extends AnyRef

A guild which that status of is unknown.
case class User(id: UserId, username: String, discriminator: String, avatar: Option[String], bot: Option[Boolean], mfaEnabled: Option[Boolean], verified: Option[Boolean], email: Option[String]) extends Author[User] with Product with Serializable

A Discord user.
A Discord user.
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.
mfaEnabled
If this user has two factor authentication enabled.
verified
If this user email is verified. Requires the email OAuth scope.
email
The users email. Requires the email OAuth scope.
type UserId = Long with Tagged[SnowflakeTag[User]]
implicit final class UserIdSyntax extends AnyVal
type UserOrRoleId = Long with Tagged[SnowflakeTag[UserOrRoleTag]]
sealed trait UserOrRoleTag extends AnyRef
case class VGuildChannel(id: ChannelId, guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRoleTag, PermissionOverwrite], bitrate: Int, userLimit: Int, nsfw: Boolean, parentId: Option[ChannelId]) extends GuildChannel with Product with Serializable

A voice channel in a guild
A voice channel in a guild
bitrate
The bitrate of this channel in bits
userLimit
The max amount of users that can join this channel
trait VerificationLevel extends AnyRef

The different verification levels that can be used for a guild.
case class VoiceRegion(id: String, name: String, sampleHostname: String, samplePort: Int, vip: Boolean, optimal: Boolean, deprecated: Boolean, custom: Boolean) extends Product with Serializable

A voice region
A voice region
id
The id of the region
name
The name of the voice region
sampleHostname
An example host name
samplePort
An example host port
vip
If this is a VIP only server
optimal
If this is the server closest to the client
deprecated
If this is a deprecated region
custom
If this is a custom region
case class VoiceState(guildId: Option[GuildId], channelId: Option[ChannelId], userId: UserId, member: Option[RawGuildMember], sessionId: String, deaf: Boolean, mute: Boolean, selfDeaf: Boolean, selfMute: Boolean, suppress: Boolean) extends GetGuildOpt with GetVChannelOpt with GetUser with Product with Serializable

Represents a user voice connection status
Represents a user voice connection status
guildId
The guild this state belongs to
channelId
The channel the user is in, or None if the user isn't in a channel.
userId
The user of this state.
member
The guild member of this voice state. Can be missing.
sessionId
The sessionId
deaf
If the user is deafened by the guild
mute
If the user is muted by the guild
selfDeaf
If the user is deafened locally
selfMute
If the user is muted locally
suppress
If the client has muted the user
case class Webhook(id: SnowflakeType[Webhook], guildId: Option[GuildId], channelId: ChannelId, user: Option[User], name: Option[String], avatar: Option[String], token: String) extends GetGuildOpt with Product with Serializable

A webhook
A webhook
id
The webhook id
guildId
The guild it belongs to
channelId
The channel it belongs to
user
The user that created the webhook. Not present when getting a webhook with a token.
name
The name of the webhook
avatar
The avatar of the webhook.
token
The token of the webhook
case class WebhookAuthor(id: SnowflakeType[Webhook], name: String, avatar: String) extends Author[Webhook] with Product with Serializable

An webhook author
An webhook author
id
The webhook id
name
The name of the webhook
avatar
The webhook's avatar hash
sealed trait WidgetImageStyle extends AnyRef

A style the widget image might be shown as.
A style the widget image might be shown as. See examples here. https://discordapp.com/developers/docs/resources/guild#get-guild-widget-image

Value Members

object AuditLogChange
object AuditLogEvent
object ChannelId
object ChannelType
object DiscordProtocol extends DiscordProtocol
object EmojiId
object FilterLevel
object GuildId
object ImageData
object ImageFormat
object IntegrationId
object MFALevel
object MessageActivityType
object MessageId
object MessageType
object NotificationLevel
object Permission
object PermissionOverwriteType
object PresenceStatus
object RawSnowflake
object RoleId
object SnowflakeType
object UserId
object UserOrRoleId
object VerificationLevel
object WidgetImageStyle
implicit def liftRole(userId: RoleId): UserOrRoleId
implicit def liftUser(userId: UserId): UserOrRoleId
package raw

package data

Type Members

sealed trait Activity extends AnyRef

case class ActivityAsset(largeImage: Option[String], largeText: Option[String], smallImage: Option[String], smallText: Option[String]) extends Product with Serializable

case class ActivityParty(id: Option[String], currentSize: Option[Int], maxSize: Option[Int]) extends Product with Serializable

case class ActivityTimestamps(start: Option[Instant], end: Option[Instant]) extends Product with Serializable

case class Attachment(id: SnowflakeType[Attachment], filename: String, size: Int, url: String, proxyUrl: String, height: Option[Int], width: Option[Int]) extends Product with Serializable

case class AuditLog(webhooks: Seq[Webhook], users: Seq[User], auditLogEntries: Seq[AuditLogEntry]) extends Product with Serializable

sealed trait AuditLogChange[A] extends AnyRef

case class AuditLogEntry(targetId: Option[RawSnowflake], changes: Option[Seq[AuditLogChange[_]]], userId: UserId, id: RawSnowflake, actionType: AuditLogEvent, options: Option[OptionalAuditLogInfo], reason: Option[String]) extends Product with Serializable

sealed trait AuditLogEvent extends AnyRef

sealed trait Author[A] extends AnyRef

case class Ban(reason: Option[String], user: UserId) extends Product with Serializable

sealed trait Channel extends AnyRef

type ChannelId = Long with Tagged[SnowflakeTag[Channel]]

implicit final class ChannelIdSyntax extends AnyVal

sealed trait ChannelType extends AnyRef

case class Connection(id: String, name: String, type: String, revoked: Boolean, integrations: Seq[Integration]) extends Product with Serializable

case class DMChannel(id: ChannelId, lastMessageId: Option[MessageId], userId: UserId) extends Channel with TChannel with GetUser with Product with Serializable

trait DiscordProtocol extends AnyRef

case class EmbedField(name: String, value: String, inline: Option[Boolean] = None) extends Product with Serializable

case class Emoji(id: EmojiId, name: String, roles: Seq[RoleId], userId: Option[UserId], requireColons: Boolean, managed: Boolean, animated: Boolean) extends Product with Serializable

type EmojiId = Long with Tagged[SnowflakeTag[Emoji]]

implicit final class EmojiIdSyntax extends AnyVal

trait FilterLevel extends AnyRef

trait GetGuild extends AnyRef

trait GetGuildOpt extends AnyRef

trait GetTChannel extends AnyRef

trait GetUser extends AnyRef

trait GetVChannelOpt extends AnyRef

case class GroupDMChannel(id: ChannelId, name: String, users: Seq[UserId], lastMessageId: Option[MessageId], ownerId: UserId, applicationId: Option[RawSnowflake], icon: Option[String]) extends Channel with TChannel with Product with Serializable

case class GuildCategory(id: ChannelId, guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRoleTag, PermissionOverwrite], nsfw: Boolean, parentId: Option[ChannelId]) extends GuildChannel with Product with Serializable

sealed trait GuildChannel extends Channel with GetGuild

case class GuildEmbed(enabled: Boolean, channelId: Option[ChannelId]) extends Product with Serializable

type GuildId = Long with Tagged[SnowflakeTag[Guild]]

implicit final class GuildIdSyntax extends AnyVal

case class GuildMember(userId: UserId, guildId: GuildId, nick: Option[String], roleIds: Seq[RoleId], joinedAt: OffsetDateTime, deaf: Boolean, mute: Boolean) extends GetUser with GetGuild with Product with Serializable

final class ImageData extends AnyVal

sealed trait ImageFormat extends AnyRef

case class Integration(id: IntegrationId, name: String, type: String, enabled: Boolean, syncing: Boolean, roleId: RoleId, expireBehavior: Int, expireGracePeriod: Int, user: User, account: IntegrationAccount, syncedAt: OffsetDateTime) extends Product with Serializable

case class IntegrationAccount(id: String, name: String) extends Product with Serializable

type IntegrationId = Long with Tagged[SnowflakeTag[Integration]]

case class Invite(code: String, guild: InviteGuild, channel: InviteChannel, approximatePresenceCount: Option[Int], approximateMemberCount: Option[Int]) extends Product with Serializable

case class InviteChannel(id: ChannelId, name: String, type: ChannelType) extends Product with Serializable

case class InviteGuild(id: GuildId, name: String, splash: Option[String], icon: Option[String]) extends Product with Serializable

case class InviteWithMetadata(code: String, guild: InviteGuild, channel: InviteChannel, inviter: User, uses: Int, maxUses: Int, maxAge: Int, temporary: Boolean, createdAt: OffsetDateTime, revoked: Boolean) extends Product with Serializable

trait MFALevel extends AnyRef

case class MessageActivity(activityType: MessageActivityType, partyId: Option[String]) extends Product with Serializable

sealed trait MessageActivityType extends AnyRef

case class MessageApplication(id: RawSnowflake, coverImage: String, description: String, icon: String, name: String) extends Product with Serializable

type MessageId = Long with Tagged[SnowflakeTag[Message]]

implicit final class MessageIdSyntax extends AnyVal

trait MessageType extends AnyRef

trait NotificationLevel extends AnyRef

case class OptionalAuditLogInfo(deleteMemberDays: Option[String], membersRemoved: Option[String], channelId: Option[ChannelId], count: Option[String], id: Option[UserOrRoleId], type: Option[PermissionOverwriteType], roleName: Option[String]) extends Product with Serializable

case class OutgoingEmbedAuthor(name: String, url: Option[String] = None, iconUrl: Option[String] = None) extends Product with Serializable

case class OutgoingEmbedFooter(text: String, iconUrl: Option[String] = None) extends Product with Serializable

case class OutgoingEmbedImage(url: String) extends Product with Serializable

case class OutgoingEmbedThumbnail(url: String) extends Product with Serializable

case class OutgoingEmbedVideo(url: String) extends Product with Serializable

case class PartialEmoji(id: Option[EmojiId], name: String) extends Product with Serializable

type Permission = Long with Tagged[Permission.type]

case class PermissionOverwrite(id: UserOrRoleId, type: PermissionOverwriteType, allow: Permission, deny: Permission) extends Product with Serializable

sealed trait PermissionOverwriteType extends AnyRef

implicit final class PermissionSyntax extends AnyVal

case class Presence(userId: UserId, activity: Option[Activity], status: PresenceStatus) extends GetUser with Product with Serializable

case class PresenceGame(name: String, timestamps: Option[ActivityTimestamps], applicationId: Option[RawSnowflake], details: Option[String], state: Option[String], party: Option[ActivityParty], assets: Option[ActivityAsset]) extends Activity with Product with Serializable

case class PresenceListening(name: String, timestamps: Option[ActivityTimestamps], details: Option[String], assets: Option[ActivityAsset]) extends Activity with Product with Serializable

sealed trait PresenceStatus extends AnyRef

case class PresenceStreaming(name: String, uri: Option[String], timestamps: Option[ActivityTimestamps], applicationId: Option[RawSnowflake], details: Option[String], state: Option[String], party: Option[ActivityParty], assets: Option[ActivityAsset]) extends Activity with Product with Serializable

type RawSnowflake = Long with Tagged[SnowflakeTag[RawSnowflakeTag]]

sealed trait RawSnowflakeTag extends AnyRef

case class Reaction(count: Int, me: Boolean, emoji: PartialEmoji) extends Product with Serializable

case class ReceivedEmbedAuthor(name: Option[String], url: Option[String], iconUrl: Option[String], proxyIconUrl: Option[String]) extends Product with Serializable

case class ReceivedEmbedFooter(text: String, iconUrl: Option[String], proxyIconUrl: Option[String]) extends Product with Serializable

case class ReceivedEmbedImage(url: Option[String], proxyUrl: Option[String], height: Option[Int], width: Option[Int]) extends Product with Serializable

case class ReceivedEmbedProvider(name: Option[String], url: Option[String]) extends Product with Serializable

case class ReceivedEmbedThumbnail(url: Option[String], proxyUrl: Option[String], height: Option[Int], width: Option[Int]) extends Product with Serializable

case class ReceivedEmbedVideo(url: Option[String], height: Option[Int], width: Option[Int]) extends Product with Serializable