data

package data

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

data
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Package Members

package raw

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 ActivityEmoji(name: String, id: Option[EmojiId], animated: Option[Boolean]) extends Product with Serializable
The emoji of a custom status.
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], integrations: Seq[PartialIntegration]) extends Product with Serializable
Root audit log object.
Root audit log object. Received from ackcord.requests.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 GetUser with 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 abstract class AuditLogEvent extends IntEnumEntry
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], userId: UserId) extends Product with Serializable
Represents a banned user.
Represents a banned user.
reason
Why the user was banned.
userId
The user that was baned.
sealed trait Channel extends AnyRef
Base channel type
type ChannelId = data.SnowflakeType.SnowflakeType[Channel]
implicit final class ChannelIdSyntax extends AnyVal
case class ChannelMention(id: TextChannelId, guildId: GuildId, type: ChannelType, name: String) extends Product with Serializable
Basic info of a channel in a cross posted message.
Basic info of a channel in a cross posted message.
id
The id of the channel
guildId
The guild the channel is in
name
The name of the channel
sealed abstract class ChannelType extends IntEnumEntry
Different type of channels
case class ClientStatus(desktop: Option[PresenceStatus], mobile: Option[PresenceStatus], web: Option[PresenceStatus]) extends Product with Serializable
The status of a user per platform.
The status of a user per platform. Not present if the user is offline, or invisible.
case class Connection(id: String, name: String, type: String, revoked: Boolean, integrations: Seq[Integration], verified: Boolean, friendSync: Boolean, showActivity: Boolean, visibility: ConnectionVisibility) 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.
verified
If the connection is verified.
friendSync
If friend sync is enabled for the connection.
showActivity
If things related this this connection will be included in presence updates.
visibility
The visibility of the connection
sealed abstract class ConnectionVisibility extends IntEnumEntry
case class CreatedInvite(code: String, guildId: Option[GuildId], channelId: GuildChannelId, inviter: Option[User], uses: Int, maxUses: Int, maxAge: Int, temporary: Boolean, createdAt: OffsetDateTime) extends Product with Serializable
A newly created invite.
A newly created invite.
code
An invite code.
guildId
The guild the invite is for.
channelId
The channel the invite is for.
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
case class DMChannel(id: SnowflakeType[DMChannel], lastMessageId: Option[MessageId], userId: UserId) extends Channel with TextChannel 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.
sealed abstract class EmbedType extends StringEnumEntry
case class Emoji(id: EmojiId, name: String, roles: Seq[RoleId], userId: Option[UserId], requireColons: Option[Boolean], managed: Option[Boolean], animated: Option[Boolean], available: Option[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.
available
If the emoji can be used.
type EmojiId = data.SnowflakeType.SnowflakeType[Emoji]
implicit final class EmojiIdSyntax extends AnyVal
sealed abstract class FilterLevel extends IntEnumEntry
The different explicit content filter levels to use for a guild.
trait GetGuild extends AnyRef
trait GetGuildOpt extends AnyRef
trait GetUser extends AnyRef
trait GetVoiceChannelOpt extends AnyRef
case class GroupDMChannel(id: SnowflakeType[GroupDMChannel], name: String, users: Seq[UserId], lastMessageId: Option[MessageId], ownerId: UserId, applicationId: Option[RawSnowflake], icon: Option[String]) extends Channel with TextChannel 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], discoverySplash: Option[String], isOwner: Option[Boolean], ownerId: UserId, permissions: Option[Permission], region: String, afkChannelId: Option[VoiceGuildChannelId], afkTimeout: Int, embedEnabled: Option[Boolean], embedChannelId: Option[GuildChannelId], verificationLevel: VerificationLevel, defaultMessageNotifications: NotificationLevel, explicitContentFilter: FilterLevel, roles: SnowflakeMap[Role, Role], emojis: SnowflakeMap[Emoji, Emoji], features: Seq[GuildFeature], mfaLevel: MFALevel, applicationId: Option[RawSnowflake], widgetEnabled: Option[Boolean], widgetChannelId: Option[GuildChannelId], systemChannelId: Option[TextGuildChannelId], systemChannelFlags: SystemChannelFlags, rulesChannelId: Option[TextGuildChannelId], joinedAt: OffsetDateTime, large: Boolean, memberCount: Int, voiceStates: SnowflakeMap[User, VoiceState], members: SnowflakeMap[User, GuildMember], channels: SnowflakeMap[GuildChannel, GuildChannel], presences: SnowflakeMap[User, Presence], maxPresences: Int, maxMembers: Option[Int], vanityUrlCode: Option[String], description: Option[String], banner: Option[String], premiumTier: PremiumTier, premiumSubscriptionCount: Option[Int], preferredLocale: Option[String], publicUpdatesChannelId: Option[TextGuildChannelId]) 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.
discoverySplash
The discovery splash hash.
isOwner
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 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 public guild.
publicUpdatesChannelId
The channel where admin and mods can see public updates are sent to public guilds.
case class GuildCategory(id: SnowflakeType[GuildCategory], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]]) extends GuildChannel with Product with Serializable
A category in a guild
sealed trait GuildChannel extends Channel with GetGuild
A channel within a guild
type GuildChannelId = data.SnowflakeType.SnowflakeType[GuildChannel]
implicit final class GuildChannelIdSyntax extends AnyVal
case class GuildEmbed(enabled: Boolean, channelId: Option[GuildChannelId]) extends Product with Serializable
sealed abstract class GuildFeature extends StringEnumEntry
case class GuildGatewayMessage(id: MessageId, channelId: TextGuildChannelId, guildId: GuildId, authorId: RawSnowflake, isAuthorUser: Boolean, authorUsername: String, member: Option[GuildMember], content: String, timestamp: OffsetDateTime, editedTimestamp: Option[OffsetDateTime], tts: Boolean, mentionEveryone: Boolean, mentions: Seq[UserId], mentionRoles: Seq[RoleId], mentionChannels: Seq[ChannelMention], attachment: Seq[Attachment], embeds: Seq[ReceivedEmbed], reactions: Seq[Reaction], nonce: Option[String], pinned: Boolean, messageType: MessageType, activity: Option[MessageActivity], application: Option[MessageApplication], messageReference: Option[MessageReference], flags: Option[MessageFlags]) extends Message with Product with Serializable
A message sent with additional guild info.
A message sent with additional guild info. Note that a message can still be sent to a guild, but be missing the guild info. For example if it's gotten from a REST request.
guildId
The guild this message was sent to.
isAuthorUser
If the author of this message was a user.
member
The guild member user that sent this message.
mentionRoles
All the roles this message mentions.
type GuildId = data.SnowflakeType.SnowflakeType[Guild]
implicit final class GuildIdSyntax extends AnyVal
case class GuildMember(userId: UserId, guildId: GuildId, nick: Option[String], roleIds: Seq[RoleId], joinedAt: OffsetDateTime, premiumSince: Option[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.
premiumSince
When this user boosted the server.
deaf
If this user is deaf.
mute
IF this user is mute.
case class GuildPreview(id: GuildId, name: String, icon: Option[String], splash: Option[String], discoverySplash: Option[String], emojis: Seq[RawEmoji], features: Seq[GuildFeature], approximateMemberCount: Int, approximatePresenceCount: Int, description: Option[String]) extends Product with Serializable
A preview of a public guild
A preview of a public guild
id
The id of the guild.
name
The name of the guild.
icon
The icon hash.
splash
The splash hash.
discoverySplash
The discovery splash hash.
emojis
The emojis of the guild.
features
The enabled guild features.
approximateMemberCount
An approximate count of the members in the guild.
approximatePresenceCount
An approximate count of the presences in the guild.
description
A description for the guild
case class GuildStoreChannel(id: SnowflakeType[GuildStoreChannel], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]]) extends GuildChannel with Product with Serializable
A store channel in a guild
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, enableEmoticons: Option[Boolean], expireBehavior: IntegrationExpireBehavior, 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
sealed abstract class IntegrationExpireBehavior extends IntEnumEntry
type IntegrationId = data.SnowflakeType.SnowflakeType[Integration]
case class Invite(code: String, guild: Option[InviteGuild], channel: InviteChannel, inviter: Option[User], targetUser: Option[InviteTargetUser], targetUserType: Option[Int], 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.
targetUser
The target user of this invite.
targetUserType
The target user type of this invite.
approximatePresenceCount
Approximate amount of people online.
approximateMemberCount
Approximate amount of total members.
case class InviteChannel(id: GuildChannelId, 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 InviteTargetUser(id: UserId, name: String, avatar: Option[String], discriminator: String) extends Product with Serializable
The target user of an invite.
The target user of an invite.
id
The user id
name
The name of the user
avatar
The avatar hash of the user
discriminator
The discriminator of the user
case class InviteWithMetadata(code: String, guild: Option[InviteGuild], channel: InviteChannel, inviter: Option[User], targetUser: Option[InviteTargetUser], targetUserType: Option[Int], approximatePresenceCount: Option[Int], approximateMemberCount: Option[Int], uses: Int, maxUses: Int, maxAge: Int, temporary: Boolean, createdAt: OffsetDateTime) 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.
targetUser
The target user of this invite.
targetUserType
The target user type of this invite.
approximatePresenceCount
Approximate amount of people online.
approximateMemberCount
Approximate amount of total members.
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
sealed abstract class MFALevel extends IntEnumEntry
sealed trait Message extends AnyRef
case class MessageActivity(activityType: MessageActivityType, partyId: Option[String]) extends Product with Serializable
activityType
Activity type.
partyId
Party id from rich presence.
sealed abstract class MessageActivityType extends IntEnumEntry
case class MessageApplication(id: RawSnowflake, coverImage: Option[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 MessageFlags = data.MessageFlags.MessageFlags
implicit final class MessageFlagsSyntax extends AnyVal
type MessageId = data.SnowflakeType.SnowflakeType[Message]
implicit final class MessageIdSyntax extends AnyVal
case class MessageReference(messageId: Option[MessageId], channelId: TextChannelId, guildId: Option[GuildId]) extends Product with Serializable
A reference to another message.
sealed abstract class MessageType extends IntEnumEntry
An enum of all the different message types.
case class NewsTextGuildChannel(id: SnowflakeType[NewsTextGuildChannel], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], topic: Option[String], lastMessageId: Option[MessageId], nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]], lastPinTimestamp: Option[OffsetDateTime]) extends TextGuildChannel with Product with Serializable
A news channel in a guild.
A news channel in a guild. For the most part you can treat this like any other text channel.
case class NormalTextGuildChannel(id: SnowflakeType[NormalTextGuildChannel], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], topic: Option[String], lastMessageId: Option[MessageId], rateLimitPerUser: Option[Int], nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]], lastPinTimestamp: Option[OffsetDateTime]) extends TextGuildChannel with Product with Serializable
A normal text channel in a guild
sealed abstract class NotificationLevel extends IntEnumEntry
The different notification levels that can be used for a guild
case class OptionalAuditLogInfo(deleteMemberDays: Option[String], membersRemoved: Option[String], channelId: Option[TextChannelId], messageId: Option[MessageId], 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.
messageId
The message that was targeted. Present for MessagePin and MessageUnpin
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: Option[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.
case class PartialIntegration(id: IntegrationId, name: String, type: String, account: IntegrationAccount) extends Product with Serializable
type Permission = data.Permission.Permission
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 abstract class PermissionOverwriteType extends StringEnumEntry
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
sealed abstract class PremiumTier extends IntEnumEntry
sealed abstract class PremiumType extends IntEnumEntry
case class Presence(userId: UserId, activity: Option[Activity], status: PresenceStatus, clientStatus: ClientStatus) 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
clientStatus
The status of the user over several platforms
case class PresenceCustom(name: String, createdAt: Instant, state: Option[String], emoji: Option[ActivityEmoji]) extends Activity with Product with Serializable
case class PresenceGame(name: String, createdAt: Instant, 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, createdAt: Instant, timestamps: Option[ActivityTimestamps], details: Option[String], assets: Option[ActivityAsset]) extends Activity with Product with Serializable
The presence of someone listening to music
sealed abstract class PresenceStatus extends StringEnumEntry
The different statuses a user can have
case class PresenceStreaming(name: String, uri: Option[String], createdAt: Instant, 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.
case class PresenceWatching(name: String, createdAt: Instant, timestamps: Option[ActivityTimestamps], details: Option[String], assets: Option[ActivityAsset]) extends Activity with Product with Serializable
The presence of someone watching something
type RawSnowflake = data.SnowflakeType.SnowflakeType[Any]
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[EmbedType], 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 UserOrRole 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 = data.SnowflakeType.SnowflakeType[Role]
implicit final class RoleIdSyntax extends AnyVal
type SnowflakeType[+A] = data.SnowflakeType.SnowflakeType[A]
implicit final class SnowflakeTypeSyntax extends AnyVal
case class SparseMessage(id: MessageId, channelId: TextChannelId, authorId: RawSnowflake, isAuthorUser: Boolean, authorUsername: String, content: String, timestamp: OffsetDateTime, editedTimestamp: Option[OffsetDateTime], tts: Boolean, mentionEveryone: Boolean, mentions: Seq[UserId], mentionChannels: Seq[ChannelMention], attachment: Seq[Attachment], embeds: Seq[ReceivedEmbed], reactions: Seq[Reaction], nonce: Option[String], pinned: Boolean, messageType: MessageType, activity: Option[MessageActivity], application: Option[MessageApplication], messageReference: Option[MessageReference], flags: Option[MessageFlags]) extends Message with Product with Serializable
A message missing the guild info.
A message missing the guild info. This can be because it was sent to a DM channel, or because it was retrieved later through a REST call. Note that a message can still be sent to a guild, but be missing the guild info. For example if it's gotten from a REST request.
type SystemChannelFlags = data.SystemChannelFlags.SystemChannelFlags
implicit final class SystemChannelFlagsSyntax extends AnyVal
case class Team(icon: Option[String], id: SnowflakeType[Team], members: Seq[TeamMember], ownerUserId: UserId) extends Product with Serializable
A discord team.
A discord team.
icon
Icon identifier for the team.
id
Id of the team.
members
Members of the team.
ownerUserId
The id of the current owner of the team
case class TeamMember(membershipState: TeamMembershipState, permissions: Seq[String], teamId: SnowflakeType[Team], user: PartialUser) extends Product with Serializable
A member of a team.
A member of a team.
membershipState
The membership state of the member
permissions
The permissions of team member
teamId
The id of the team this member belongs to
user
A partial user containing the avatar, discriminator, id and username of the user
sealed abstract class TeamMembershipState extends IntEnumEntry
sealed trait TextChannel extends Channel
A text channel that has text messages
type TextChannelId = data.SnowflakeType.SnowflakeType[TextChannel]
implicit final class TextChannelIdSyntax extends AnyVal
sealed trait TextGuildChannel extends GuildChannel with TextChannel
A texual channel in a guild
type TextGuildChannelId = data.SnowflakeType.SnowflakeType[TextGuildChannel]
implicit final class TextGuildChannelIdSyntax extends AnyVal
case class UnavailableGuild(id: GuildId, unavailable: Option[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 because of an outage.
sealed trait UnknownStatusGuild extends AnyRef
A guild which that status of is unknown.
case class UnsupportedChannel(id: ChannelId, channelType: ChannelType) extends Channel with Product with Serializable
A channel that is of a type that AckCord knows about, but doesn't implement.
A channel that is of a type that AckCord knows about, but doesn't implement. Normally because it's not yet part of the public API.
case class User(id: UserId, username: String, discriminator: String, avatar: Option[String], bot: Option[Boolean], system: Option[Boolean], mfaEnabled: Option[Boolean], locale: Option[String], verified: Option[Boolean], email: Option[String], flags: Option[UserFlags], premiumType: Option[PremiumType]) extends Author[User] with UserOrRole 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.
system
If the user is part of Discord's urgent messaging system.
mfaEnabled
If this user has two factor authentication enabled.
locale
The user's chosen language.
verified
If this user email is verified. Requires the email OAuth scope.
email
The users email. Requires the email OAuth scope.
type UserFlags = data.UserFlags.UserFlags
implicit final class UserFlagsSyntax extends AnyVal
type UserId = data.SnowflakeType.SnowflakeType[User]
implicit final class UserIdSyntax extends AnyVal
trait UserOrRole extends AnyRef
type UserOrRoleId = data.SnowflakeType.SnowflakeType[UserOrRole]
sealed abstract class VerificationLevel extends IntEnumEntry
The different verification levels that can be used for a guild.
case class VoiceGuildChannel(id: SnowflakeType[VoiceGuildChannel], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], bitrate: Int, userLimit: Int, nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]]) 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
type VoiceGuildChannelId = data.SnowflakeType.SnowflakeType[VoiceGuildChannel]
implicit final class VoiceGuildChannelIdSyntax extends AnyVal
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[VoiceGuildChannelId], userId: UserId, member: Option[RawGuildMember], sessionId: String, deaf: Boolean, mute: Boolean, selfDeaf: Boolean, selfMute: Boolean, selfStream: Option[Boolean], suppress: Boolean) extends GetGuildOpt with GetVoiceChannelOpt 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
selfStream
If the user is streaming
suppress
If the client has muted the user
case class Webhook(id: SnowflakeType[Webhook], type: WebhookType, guildId: Option[GuildId], channelId: TextGuildChannelId, user: Option[User], name: Option[String], avatar: Option[String], token: Option[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], username: String, avatar: String) extends Author[Webhook] with Product with Serializable
An webhook author
An webhook author
id
The webhook id
username
The name of the webhook
avatar
The webhook's avatar hash
sealed abstract class WebhookType extends IntEnumEntry
sealed abstract class WidgetImageStyle extends StringEnumEntry
A style the widget image might be shown as.
A style the widget image might be shown as. See examples here. https://discord.com/developers/docs/resources/guild#get-guild-widget-image

Value Members

object AuditLogChange
object AuditLogEvent extends IntEnum[AuditLogEvent] with IntCirceEnumWithUnknown[AuditLogEvent]
object ChannelId extends SnowflakeCompanion[Channel]
object ChannelType extends IntEnum[ChannelType] with IntCirceEnumWithUnknown[ChannelType]
object ConnectionVisibility extends IntEnum[ConnectionVisibility] with IntCirceEnumWithUnknown[ConnectionVisibility]
object DiscordProtocol extends DiscordProtocol
object EmbedType extends StringEnum[EmbedType] with StringCirceEnumWithUnknown[EmbedType]
object EmojiId extends SnowflakeCompanion[EmojiId]
object FilterLevel extends IntEnum[FilterLevel] with IntCirceEnumWithUnknown[FilterLevel]
object GuildChannelId extends SnowflakeCompanion[GuildChannel]
object GuildFeature extends StringEnum[GuildFeature] with StringCirceEnumWithUnknown[GuildFeature]
object GuildId extends SnowflakeCompanion[Guild]
object ImageData
object ImageFormat
object IntegrationExpireBehavior extends IntEnum[IntegrationExpireBehavior] with IntCirceEnumWithUnknown[IntegrationExpireBehavior]
object IntegrationId extends SnowflakeCompanion[Integration]
object MFALevel extends IntEnum[MFALevel] with IntCirceEnumWithUnknown[MFALevel]
object MessageActivityType extends IntEnum[MessageActivityType] with IntCirceEnumWithUnknown[MessageActivityType]
object MessageFlags
object MessageId extends SnowflakeCompanion[Message]
object MessageType extends IntEnum[MessageType] with IntCirceEnumWithUnknown[MessageType]
object NotificationLevel extends IntEnum[NotificationLevel] with IntCirceEnumWithUnknown[NotificationLevel]
object Permission
object PermissionOverwriteType extends StringEnum[PermissionOverwriteType] with StringCirceEnumWithUnknown[PermissionOverwriteType]
object PremiumTier extends IntEnum[PremiumTier] with IntCirceEnumWithUnknown[PremiumTier]
object PremiumType extends IntEnum[PremiumType] with IntCirceEnumWithUnknown[PremiumType]
object PresenceStatus extends StringEnum[PresenceStatus] with StringCirceEnumWithUnknown[PresenceStatus]
object RawSnowflake extends SnowflakeCompanion[Any]
object RoleId extends SnowflakeCompanion[Role]
object SnowflakeType
object SystemChannelFlags
object TeamMembershipState extends IntEnum[TeamMembershipState] with IntCirceEnumWithUnknown[TeamMembershipState]
object TextChannelId extends SnowflakeCompanion[TextChannel]
object TextGuildChannelId extends SnowflakeCompanion[TextGuildChannel]
object UserFlags
object UserId extends SnowflakeCompanion[User]
object UserOrRoleId extends SnowflakeCompanion[UserOrRole]
object VerificationLevel extends IntEnum[VerificationLevel] with IntCirceEnumWithUnknown[VerificationLevel]
object VoiceGuildChannelId extends SnowflakeCompanion[VoiceGuildChannel]
object WebhookType extends IntEnum[WebhookType] with IntCirceEnumWithUnknown[WebhookType]
object WidgetImageStyle extends StringEnum[WidgetImageStyle]

Packages

data

package data

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

data

package data

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

data