Safe Haskell	Safe-Inferred
Language	Haskell2010

Discord.Internal.Types.Guild

Description

Types relating to Discord Guilds (servers)

Synopsis

data Guild = Guild {
- guildId :: GuildId
- guildName :: Text
- guildIcon :: Maybe Text
- guildIconHash :: Maybe Text
- guildSplash :: Maybe Text
- guildDiscoverySplash :: Maybe Text
- guildOwner :: Maybe Bool
- guildOwnerId :: UserId
- guildPermissions :: Maybe Text
- guildAfkId :: Maybe ChannelId
- guildAfkTimeout :: Integer
- guildWidgetEnabled :: Maybe Bool
- guildWidgetChannelId :: Maybe ChannelId
- guildVerificationLevel :: Integer
- guildNotification :: Integer
- guildExplicitFilterLevel :: Integer
- guildRoles :: [Role]
- guildEmojis :: [Emoji]
- guildFeatures :: [Text]
- guildMultiFactAuth :: !Integer
- guildApplicationId :: Maybe ApplicationId
- guildSystemChannelId :: Maybe ChannelId
- guildSystemChannelFlags :: Integer
- guildRulesChannelId :: Maybe ChannelId
- guildMaxPresences :: Maybe Integer
- guildMaxMembers :: Maybe Integer
- guildVanityURL :: Maybe Text
- guildDescription :: Maybe Text
- guildBanner :: Maybe Text
- guildPremiumTier :: Integer
- guildSubscriptionCount :: Maybe Integer
- guildPreferredLocale :: Text
- guildPublicUpdatesChannel :: Maybe ChannelId
- guildMaxVideoUsers :: Maybe Integer
- guildApproxMemberCount :: Maybe Integer
- guildApproxPresenceCount :: Maybe Integer
- guildNSFWLevel :: Integer
- guildStickers :: Maybe [StickerItem]
- guildPremiumBar :: Bool
}
newtype GuildUnavailable = GuildUnavailable {
- idOnceAvailable :: GuildId
}
data PresenceInfo = PresenceInfo {
- presenceUserId :: UserId
- presenceActivities :: Maybe [(Activity, Maybe [Text])]
- presenceGuildId :: Maybe GuildId
- presenceStatus :: Maybe Text
}
data Activity = Activity {
- activityName :: Text
- activityType :: ActivityType
- activityUrl :: Maybe Text
- activityCreatedAt :: Integer
- activityTimeStamps :: Maybe ActivityTimestamps
- activityApplicationId :: Maybe ApplicationId
- activityDetails :: Maybe Text
- activityState :: Maybe Text
- activityEmoji :: Maybe Emoji
- activityParty :: Maybe ActivityParty
- activityInstance :: Maybe Bool
- activityFlags :: Maybe Integer
- activityButtons :: Maybe [ActivityButton]
}
mkActivity :: Text -> ActivityType -> Activity
data ActivityTimestamps = ActivityTimestamps {
- activityTimestampsStart :: Maybe Integer
- activityTimestampsEnd :: Maybe Integer
}
data ActivityParty = ActivityParty {
- activityPartyId :: Maybe Text
- activityPartySize :: Maybe (Integer, Integer)
}
data ActivityButton = ActivityButton {
- activityButtonLabel :: Text
- activityButtonUrl :: Text
}
data ActivityType
- = ActivityTypeGame
- | ActivityTypeStreaming
- | ActivityTypeListening
- | ActivityTypeWatching
- | ActivityTypeCustom
- | ActivityTypeCompeting
data PartialGuild = PartialGuild {
- partialGuildId :: GuildId
- partialGuildName :: Text
- partialGuildIcon :: Maybe Text
- partialGuildOwner :: Bool
- partialGuildPermissions :: Text
}
data Role = Role {
- roleId :: RoleId
- roleName :: Text
- roleColor :: DiscordColor
- roleHoist :: Bool
- rolePos :: Integer
- rolePerms :: RolePermissions
- roleManaged :: Bool
- roleMention :: Bool
}
roleIdToRole :: Guild -> RoleId -> Maybe Role
data VoiceRegion = VoiceRegion {
- voiceRegionId :: Text
- voiceRegionName :: Text
- voiceRegionVip :: Bool
- voiceRegionOptimal :: Bool
- voiceRegionDeprecated :: Bool
- voiceRegionCustom :: Bool
}
data GuildBan = GuildBan {
- guildBanReason :: Text
- guildBanUser :: User
}
data Invite = Invite {
- inviteCode :: Text
- inviteGuildId :: Maybe GuildId
- inviteChannelId :: ChannelId
}
data InviteWithMeta = InviteWithMeta Invite InviteMeta
data InviteMeta = InviteMeta {
- inviteCreator :: User
- inviteUses :: Integer
- inviteMax :: Integer
- inviteAge :: Integer
- inviteTemp :: Bool
- inviteCreated :: UTCTime
- inviteRevoked :: Bool
}
data Integration = Integration {
- integrationId :: !Snowflake
- integrationName :: Text
- integrationType :: Text
- integrationEnabled :: Bool
- integrationSyncing :: Bool
- integrationRole :: RoleId
- integrationBehavior :: Integer
- integrationGrace :: Integer
- integrationOwner :: User
- integrationAccount :: IntegrationAccount
- integrationSync :: UTCTime
}
data IntegrationAccount = IntegrationAccount {
- accountId :: Text
- accountName :: Text
}
data GuildWidget = GuildWidget {
- widgetEnabled :: Bool
- widgetChannelId :: ChannelId
}

Documentation

data Guild Source #

Guilds in Discord represent a collection of users and channels into an isolated Server

https://discord.com/developers/docs/resources/guild#guild-object

Constructors

Guild

Fields

guildId :: GuildId
Guild id
guildName :: Text
Guild name (2 - 100 chars)
guildIcon :: Maybe Text
Icon hash
guildIconHash :: Maybe Text
Icon hash, when returned in template object
guildSplash :: Maybe Text
Splash hash
guildDiscoverySplash :: Maybe Text
Discovery splash hash
guildOwner :: Maybe Bool
True is user is the owner of the guild
guildOwnerId :: UserId
Guild owner id
guildPermissions :: Maybe Text
Total permissions for the user in the guild
guildAfkId :: Maybe ChannelId
Id of afk channel
guildAfkTimeout :: Integer
Afk timeout in seconds
guildWidgetEnabled :: Maybe Bool
Id of embedded channel
guildWidgetChannelId :: Maybe ChannelId
Id of embedded channel
guildVerificationLevel :: Integer
Level of verification
guildNotification :: Integer
Level of default notifications
guildExplicitFilterLevel :: Integer
Whose media gets scanned
guildRoles :: [Role]
Array of Role objects
guildEmojis :: [Emoji]
Array of Emoji objects
guildFeatures :: [Text]
Array of guild feature strings
guildMultiFactAuth :: !Integer
MFA level for the guild
guildApplicationId :: Maybe ApplicationId
Application id of the guild if bot created
guildSystemChannelId :: Maybe ChannelId
Channel where guild notices such as welcome messages and boost events
guildSystemChannelFlags :: Integer
Flags on the system channel
guildRulesChannelId :: Maybe ChannelId
Id of channel with rules/guidelines
guildMaxPresences :: Maybe Integer
Maximum number of prescences in the guild
guildMaxMembers :: Maybe Integer
Maximum number of members in the guild
guildVanityURL :: Maybe Text
Vanity url code for the guild
guildDescription :: Maybe Text
Description of a commmunity guild
guildBanner :: Maybe Text
Banner hash
guildPremiumTier :: Integer
Premium tier (boost level)
guildSubscriptionCount :: Maybe Integer
Number of boosts the guild has
guildPreferredLocale :: Text
Preferred locale of a community server
guildPublicUpdatesChannel :: Maybe ChannelId
Id of channel where admins and mods get updates
guildMaxVideoUsers :: Maybe Integer
Maximum number of users in video channel
guildApproxMemberCount :: Maybe Integer
Approximate number of members in the guild (GET guildsid endpoint when with_counts is true)
guildApproxPresenceCount :: Maybe Integer
Approximate number of non-offline members in the guild (GET guildsid endpoint when with_counts is true) welcome_screen
guildNSFWLevel :: Integer
Guild NSFW level stage_instances
guildStickers :: Maybe [StickerItem]
Custom guild stickers guild_scheduled_events
guildPremiumBar :: Bool
Whether the guild has the boost progress bar enabled

Instances

Instances details

FromJSON Guild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser Guild # parseJSONList :: Value -> Parser [Guild] # omittedField :: Maybe Guild #
Read Guild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS Guild # readList :: ReadS [Guild] # readPrec :: ReadPrec Guild # readListPrec :: ReadPrec [Guild] #
Show Guild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> Guild -> ShowS # show :: Guild -> String # showList :: [Guild] -> ShowS #
Eq Guild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: Guild -> Guild -> Bool # (/=) :: Guild -> Guild -> Bool #
Ord Guild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: Guild -> Guild -> Ordering # (<) :: Guild -> Guild -> Bool # (<=) :: Guild -> Guild -> Bool # (>) :: Guild -> Guild -> Bool # (>=) :: Guild -> Guild -> Bool # max :: Guild -> Guild -> Guild # min :: Guild -> Guild -> Guild #

newtype GuildUnavailable Source #

Constructors

GuildUnavailable
Fields idOnceAvailable :: GuildId

Instances

Instances details

FromJSON GuildUnavailable Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser GuildUnavailable # parseJSONList :: Value -> Parser [GuildUnavailable] # omittedField :: Maybe GuildUnavailable #
Read GuildUnavailable Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS GuildUnavailable # readList :: ReadS [GuildUnavailable] # readPrec :: ReadPrec GuildUnavailable # readListPrec :: ReadPrec [GuildUnavailable] #
Show GuildUnavailable Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> GuildUnavailable -> ShowS # show :: GuildUnavailable -> String # showList :: [GuildUnavailable] -> ShowS #
Eq GuildUnavailable Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: GuildUnavailable -> GuildUnavailable -> Bool # (/=) :: GuildUnavailable -> GuildUnavailable -> Bool #
Ord GuildUnavailable Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: GuildUnavailable -> GuildUnavailable -> Ordering # (<) :: GuildUnavailable -> GuildUnavailable -> Bool # (<=) :: GuildUnavailable -> GuildUnavailable -> Bool # (>) :: GuildUnavailable -> GuildUnavailable -> Bool # (>=) :: GuildUnavailable -> GuildUnavailable -> Bool # max :: GuildUnavailable -> GuildUnavailable -> GuildUnavailable # min :: GuildUnavailable -> GuildUnavailable -> GuildUnavailable #

data PresenceInfo Source #

Constructors

PresenceInfo
Fields presenceUserId :: UserId presenceActivities :: Maybe [(Activity, Maybe [Text])] Activities and the names of their buttons. The buttons field of Activity will be blank, as the additional maybe field will have the button names it would contain. presenceGuildId :: Maybe GuildId presenceStatus :: Maybe Text

Instances

Instances details

FromJSON PresenceInfo Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser PresenceInfo # parseJSONList :: Value -> Parser [PresenceInfo] # omittedField :: Maybe PresenceInfo #
Read PresenceInfo Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS PresenceInfo # readList :: ReadS [PresenceInfo] # readPrec :: ReadPrec PresenceInfo # readListPrec :: ReadPrec [PresenceInfo] #
Show PresenceInfo Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> PresenceInfo -> ShowS # show :: PresenceInfo -> String # showList :: [PresenceInfo] -> ShowS #
Eq PresenceInfo Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: PresenceInfo -> PresenceInfo -> Bool # (/=) :: PresenceInfo -> PresenceInfo -> Bool #
Ord PresenceInfo Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: PresenceInfo -> PresenceInfo -> Ordering # (<) :: PresenceInfo -> PresenceInfo -> Bool # (<=) :: PresenceInfo -> PresenceInfo -> Bool # (>) :: PresenceInfo -> PresenceInfo -> Bool # (>=) :: PresenceInfo -> PresenceInfo -> Bool # max :: PresenceInfo -> PresenceInfo -> PresenceInfo # min :: PresenceInfo -> PresenceInfo -> PresenceInfo #

data Activity Source #

Object for a single activity

https://discord.com/developers/docs/topics/gateway-events#activity-object

When setting a bot's activity, only the name, url, and type are sent - and it seems that not many types are permitted either.

Only youtube and twitch urls will work.

Constructors

Activity

Fields

activityName :: Text
Name of activity
activityType :: ActivityType
Type of activity
activityUrl :: Maybe Text
URL of the activity (only verified when streaming)
activityCreatedAt :: Integer
unix time in milliseconds
activityTimeStamps :: Maybe ActivityTimestamps
Start and end times
activityApplicationId :: Maybe ApplicationId
Application of the activity
activityDetails :: Maybe Text
Details of Activity
activityState :: Maybe Text
State of the user's party
activityEmoji :: Maybe Emoji
Simplified emoji object
activityParty :: Maybe ActivityParty
Info for the current player's party assets secrets
activityInstance :: Maybe Bool
Whether or not the activity is an instanced game session
activityFlags :: Maybe Integer
The flags https://discord.com/developers/docs/topics/gateway#activity-object-activity-flags
activityButtons :: Maybe [ActivityButton]
Custom buttons shown in Rich Presence. When received, always Nothing!

Instances

Instances details

FromJSON Activity Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser Activity # parseJSONList :: Value -> Parser [Activity] # omittedField :: Maybe Activity #
ToJSON Activity Source #
Instance details Defined in Discord.Internal.Types.Guild Methods toJSON :: Activity -> Value # toEncoding :: Activity -> Encoding # toJSONList :: [Activity] -> Value # toEncodingList :: [Activity] -> Encoding # omitField :: Activity -> Bool #
Read Activity Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS Activity # readList :: ReadS [Activity] # readPrec :: ReadPrec Activity # readListPrec :: ReadPrec [Activity] #
Show Activity Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> Activity -> ShowS # show :: Activity -> String # showList :: [Activity] -> ShowS #
Eq Activity Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: Activity -> Activity -> Bool # (/=) :: Activity -> Activity -> Bool #
Ord Activity Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: Activity -> Activity -> Ordering # (<) :: Activity -> Activity -> Bool # (<=) :: Activity -> Activity -> Bool # (>) :: Activity -> Activity -> Bool # (>=) :: Activity -> Activity -> Bool # max :: Activity -> Activity -> Activity # min :: Activity -> Activity -> Activity #

mkActivity :: Text -> ActivityType -> Activity Source #

The quick and easy way to make an activity for a discord bot.

To set the activityState or activityUrl, please use record field syntax.

data ActivityTimestamps Source #

Constructors

ActivityTimestamps
Fields activityTimestampsStart :: Maybe Integer unix time in milliseconds activityTimestampsEnd :: Maybe Integer unix time in milliseconds

Instances

Instances details

FromJSON ActivityTimestamps Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser ActivityTimestamps # parseJSONList :: Value -> Parser [ActivityTimestamps] # omittedField :: Maybe ActivityTimestamps #
Read ActivityTimestamps Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS ActivityTimestamps # readList :: ReadS [ActivityTimestamps] # readPrec :: ReadPrec ActivityTimestamps # readListPrec :: ReadPrec [ActivityTimestamps] #
Show ActivityTimestamps Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> ActivityTimestamps -> ShowS # show :: ActivityTimestamps -> String # showList :: [ActivityTimestamps] -> ShowS #
Eq ActivityTimestamps Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: ActivityTimestamps -> ActivityTimestamps -> Bool # (/=) :: ActivityTimestamps -> ActivityTimestamps -> Bool #
Ord ActivityTimestamps Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: ActivityTimestamps -> ActivityTimestamps -> Ordering # (<) :: ActivityTimestamps -> ActivityTimestamps -> Bool # (<=) :: ActivityTimestamps -> ActivityTimestamps -> Bool # (>) :: ActivityTimestamps -> ActivityTimestamps -> Bool # (>=) :: ActivityTimestamps -> ActivityTimestamps -> Bool # max :: ActivityTimestamps -> ActivityTimestamps -> ActivityTimestamps # min :: ActivityTimestamps -> ActivityTimestamps -> ActivityTimestamps #

data ActivityParty Source #

Constructors

ActivityParty
Fields activityPartyId :: Maybe Text activityPartySize :: Maybe (Integer, Integer)

Instances

Instances details

FromJSON ActivityParty Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser ActivityParty # parseJSONList :: Value -> Parser [ActivityParty] # omittedField :: Maybe ActivityParty #
Read ActivityParty Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS ActivityParty # readList :: ReadS [ActivityParty] # readPrec :: ReadPrec ActivityParty # readListPrec :: ReadPrec [ActivityParty] #
Show ActivityParty Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> ActivityParty -> ShowS # show :: ActivityParty -> String # showList :: [ActivityParty] -> ShowS #
Eq ActivityParty Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: ActivityParty -> ActivityParty -> Bool # (/=) :: ActivityParty -> ActivityParty -> Bool #
Ord ActivityParty Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: ActivityParty -> ActivityParty -> Ordering # (<) :: ActivityParty -> ActivityParty -> Bool # (<=) :: ActivityParty -> ActivityParty -> Bool # (>) :: ActivityParty -> ActivityParty -> Bool # (>=) :: ActivityParty -> ActivityParty -> Bool # max :: ActivityParty -> ActivityParty -> ActivityParty # min :: ActivityParty -> ActivityParty -> ActivityParty #

data ActivityButton Source #

Constructors

ActivityButton
Fields activityButtonLabel :: Text activityButtonUrl :: Text

Instances

Instances details

FromJSON ActivityButton Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser ActivityButton # parseJSONList :: Value -> Parser [ActivityButton] # omittedField :: Maybe ActivityButton #
Read ActivityButton Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS ActivityButton # readList :: ReadS [ActivityButton] # readPrec :: ReadPrec ActivityButton # readListPrec :: ReadPrec [ActivityButton] #
Show ActivityButton Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> ActivityButton -> ShowS # show :: ActivityButton -> String # showList :: [ActivityButton] -> ShowS #
Eq ActivityButton Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: ActivityButton -> ActivityButton -> Bool # (/=) :: ActivityButton -> ActivityButton -> Bool #
Ord ActivityButton Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: ActivityButton -> ActivityButton -> Ordering # (<) :: ActivityButton -> ActivityButton -> Bool # (<=) :: ActivityButton -> ActivityButton -> Bool # (>) :: ActivityButton -> ActivityButton -> Bool # (>=) :: ActivityButton -> ActivityButton -> Bool # max :: ActivityButton -> ActivityButton -> ActivityButton # min :: ActivityButton -> ActivityButton -> ActivityButton #

data ActivityType Source #

To see what these look like, go to here: https://discord.com/developers/docs/topics/gateway#activity-object-activity-types

Constructors

ActivityTypeGame
ActivityTypeStreaming
ActivityTypeListening
ActivityTypeWatching
ActivityTypeCustom
ActivityTypeCompeting

Instances

Instances details

FromJSON ActivityType Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser ActivityType # parseJSONList :: Value -> Parser [ActivityType] # omittedField :: Maybe ActivityType #
Data ActivityType Source #
Instance details Defined in Discord.Internal.Types.Guild Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ActivityType -> c ActivityType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ActivityType # toConstr :: ActivityType -> Constr # dataTypeOf :: ActivityType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ActivityType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ActivityType) # gmapT :: (forall b. Data b => b -> b) -> ActivityType -> ActivityType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ActivityType -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ActivityType -> r # gmapQ :: (forall d. Data d => d -> u) -> ActivityType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ActivityType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ActivityType -> m ActivityType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ActivityType -> m ActivityType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ActivityType -> m ActivityType #
Read ActivityType Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS ActivityType # readList :: ReadS [ActivityType] # readPrec :: ReadPrec ActivityType # readListPrec :: ReadPrec [ActivityType] #
Show ActivityType Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> ActivityType -> ShowS # show :: ActivityType -> String # showList :: [ActivityType] -> ShowS #
InternalDiscordEnum ActivityType Source #
Instance details Defined in Discord.Internal.Types.Guild Methods discordTypeStartValue :: ActivityType Source # fromDiscordType :: ActivityType -> Int Source # discordTypeTable :: [(Int, ActivityType)] Source # discordTypeParseJSON :: String -> Value -> Parser ActivityType Source #
Eq ActivityType Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: ActivityType -> ActivityType -> Bool # (/=) :: ActivityType -> ActivityType -> Bool #
Ord ActivityType Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: ActivityType -> ActivityType -> Ordering # (<) :: ActivityType -> ActivityType -> Bool # (<=) :: ActivityType -> ActivityType -> Bool # (>) :: ActivityType -> ActivityType -> Bool # (>=) :: ActivityType -> ActivityType -> Bool # max :: ActivityType -> ActivityType -> ActivityType # min :: ActivityType -> ActivityType -> ActivityType #

data PartialGuild Source #

Constructors

PartialGuild
Fields partialGuildId :: GuildId partialGuildName :: Text partialGuildIcon :: Maybe Text partialGuildOwner :: Bool partialGuildPermissions :: Text

Instances

Instances details

FromJSON PartialGuild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser PartialGuild # parseJSONList :: Value -> Parser [PartialGuild] # omittedField :: Maybe PartialGuild #
Read PartialGuild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS PartialGuild # readList :: ReadS [PartialGuild] # readPrec :: ReadPrec PartialGuild # readListPrec :: ReadPrec [PartialGuild] #
Show PartialGuild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> PartialGuild -> ShowS # show :: PartialGuild -> String # showList :: [PartialGuild] -> ShowS #
Eq PartialGuild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: PartialGuild -> PartialGuild -> Bool # (/=) :: PartialGuild -> PartialGuild -> Bool #
Ord PartialGuild Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: PartialGuild -> PartialGuild -> Ordering # (<) :: PartialGuild -> PartialGuild -> Bool # (<=) :: PartialGuild -> PartialGuild -> Bool # (>) :: PartialGuild -> PartialGuild -> Bool # (>=) :: PartialGuild -> PartialGuild -> Bool # max :: PartialGuild -> PartialGuild -> PartialGuild # min :: PartialGuild -> PartialGuild -> PartialGuild #

data Role Source #

Roles represent a set of permissions attached to a group of users. Roles have unique names, colors, and can be "pinned" to the side bar, causing their members to be listed separately. Roles are unique per guild, and can have separate permission profiles for the global context (guild) and channel context.

Constructors

Role
Fields roleId :: RoleId The role id roleName :: Text The role name roleColor :: DiscordColor Integer representation of color code roleHoist :: Bool If the role is pinned in the user listing rolePos :: Integer Position of this role rolePerms :: RolePermissions Permission bit set roleManaged :: Bool Whether this role is managed by an integration roleMention :: Bool Whether this role is mentionable

Instances

Instances details

FromJSON Role Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser Role # parseJSONList :: Value -> Parser [Role] # omittedField :: Maybe Role #
Read Role Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS Role # readList :: ReadS [Role] # readPrec :: ReadPrec Role # readListPrec :: ReadPrec [Role] #
Show Role Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> Role -> ShowS # show :: Role -> String # showList :: [Role] -> ShowS #
Eq Role Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: Role -> Role -> Bool # (/=) :: Role -> Role -> Bool #
Ord Role Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: Role -> Role -> Ordering # (<) :: Role -> Role -> Bool # (<=) :: Role -> Role -> Bool # (>) :: Role -> Role -> Bool # (>=) :: Role -> Role -> Bool # max :: Role -> Role -> Role # min :: Role -> Role -> Role #

roleIdToRole :: Guild -> RoleId -> Maybe Role Source #

If there is no such role on the guild return nothing otherwise return the role. Take the head of the list. List should always be one, because the ID is unique

data VoiceRegion Source #

VoiceRegion is only refrenced in Guild endpoints, will be moved when voice support is added

Constructors

VoiceRegion
Fields voiceRegionId :: Text Unique id of the region voiceRegionName :: Text Name of the region voiceRegionVip :: Bool True if this is a VIP only server voiceRegionOptimal :: Bool True for the closest server to a client voiceRegionDeprecated :: Bool Whether this is a deprecated region voiceRegionCustom :: Bool Whether this is a custom region

Instances

Instances details

FromJSON VoiceRegion Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser VoiceRegion # parseJSONList :: Value -> Parser [VoiceRegion] # omittedField :: Maybe VoiceRegion #
Read VoiceRegion Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS VoiceRegion # readList :: ReadS [VoiceRegion] # readPrec :: ReadPrec VoiceRegion # readListPrec :: ReadPrec [VoiceRegion] #
Show VoiceRegion Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> VoiceRegion -> ShowS # show :: VoiceRegion -> String # showList :: [VoiceRegion] -> ShowS #
Eq VoiceRegion Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: VoiceRegion -> VoiceRegion -> Bool # (/=) :: VoiceRegion -> VoiceRegion -> Bool #
Ord VoiceRegion Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: VoiceRegion -> VoiceRegion -> Ordering # (<) :: VoiceRegion -> VoiceRegion -> Bool # (<=) :: VoiceRegion -> VoiceRegion -> Bool # (>) :: VoiceRegion -> VoiceRegion -> Bool # (>=) :: VoiceRegion -> VoiceRegion -> Bool # max :: VoiceRegion -> VoiceRegion -> VoiceRegion # min :: VoiceRegion -> VoiceRegion -> VoiceRegion #

data GuildBan Source #

Info about a Ban

Constructors

GuildBan
Fields guildBanReason :: Text guildBanUser :: User

Instances

Instances details

FromJSON GuildBan Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser GuildBan # parseJSONList :: Value -> Parser [GuildBan] # omittedField :: Maybe GuildBan #
Read GuildBan Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS GuildBan # readList :: ReadS [GuildBan] # readPrec :: ReadPrec GuildBan # readListPrec :: ReadPrec [GuildBan] #
Show GuildBan Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> GuildBan -> ShowS # show :: GuildBan -> String # showList :: [GuildBan] -> ShowS #
Eq GuildBan Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: GuildBan -> GuildBan -> Bool # (/=) :: GuildBan -> GuildBan -> Bool #
Ord GuildBan Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: GuildBan -> GuildBan -> Ordering # (<) :: GuildBan -> GuildBan -> Bool # (<=) :: GuildBan -> GuildBan -> Bool # (>) :: GuildBan -> GuildBan -> Bool # (>=) :: GuildBan -> GuildBan -> Bool # max :: GuildBan -> GuildBan -> GuildBan # min :: GuildBan -> GuildBan -> GuildBan #

data Invite Source #

Represents a code to add a user to a guild

Constructors

Invite
Fields inviteCode :: Text The invite code inviteGuildId :: Maybe GuildId The guild the code will invite to inviteChannelId :: ChannelId The channel the code will invite to

Instances

Instances details

FromJSON Invite Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser Invite # parseJSONList :: Value -> Parser [Invite] # omittedField :: Maybe Invite #
Read Invite Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS Invite # readList :: ReadS [Invite] # readPrec :: ReadPrec Invite # readListPrec :: ReadPrec [Invite] #
Show Invite Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> Invite -> ShowS # show :: Invite -> String # showList :: [Invite] -> ShowS #
Eq Invite Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: Invite -> Invite -> Bool # (/=) :: Invite -> Invite -> Bool #
Ord Invite Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: Invite -> Invite -> Ordering # (<) :: Invite -> Invite -> Bool # (<=) :: Invite -> Invite -> Bool # (>) :: Invite -> Invite -> Bool # (>=) :: Invite -> Invite -> Bool # max :: Invite -> Invite -> Invite # min :: Invite -> Invite -> Invite #

data InviteWithMeta Source #

Invite code with additional metadata

Constructors

InviteWithMeta Invite InviteMeta

Instances

Instances details

FromJSON InviteWithMeta Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser InviteWithMeta # parseJSONList :: Value -> Parser [InviteWithMeta] # omittedField :: Maybe InviteWithMeta #

data InviteMeta Source #

Additional metadata about an invite.

Constructors

InviteMeta

Fields

inviteCreator :: User
The user that created the invite
inviteUses :: Integer
Number of times the invite has been used
inviteMax :: Integer
Max number of times the invite can be used
inviteAge :: Integer
The duration (in seconds) after which the invite expires
inviteTemp :: Bool
Whether this invite only grants temporary membership
inviteCreated :: UTCTime
When the invite was created
inviteRevoked :: Bool
If the invite is revoked

Instances

Instances details

FromJSON InviteMeta Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser InviteMeta # parseJSONList :: Value -> Parser [InviteMeta] # omittedField :: Maybe InviteMeta #
Read InviteMeta Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS InviteMeta # readList :: ReadS [InviteMeta] # readPrec :: ReadPrec InviteMeta # readListPrec :: ReadPrec [InviteMeta] #
Show InviteMeta Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> InviteMeta -> ShowS # show :: InviteMeta -> String # showList :: [InviteMeta] -> ShowS #
Eq InviteMeta Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: InviteMeta -> InviteMeta -> Bool # (/=) :: InviteMeta -> InviteMeta -> Bool #
Ord InviteMeta Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: InviteMeta -> InviteMeta -> Ordering # (<) :: InviteMeta -> InviteMeta -> Bool # (<=) :: InviteMeta -> InviteMeta -> Bool # (>) :: InviteMeta -> InviteMeta -> Bool # (>=) :: InviteMeta -> InviteMeta -> Bool # max :: InviteMeta -> InviteMeta -> InviteMeta # min :: InviteMeta -> InviteMeta -> InviteMeta #

data Integration Source #

Represents the behavior of a third party account link.

Constructors

Integration

Fields

integrationId :: !Snowflake
Integration id
integrationName :: Text
Integration name
integrationType :: Text
Integration type (Twitch, Youtube, ect.)
integrationEnabled :: Bool
Is the integration enabled
integrationSyncing :: Bool
Is the integration syncing
integrationRole :: RoleId
Id the integration uses for "subscribers"
integrationBehavior :: Integer
The behavior of expiring subscribers
integrationGrace :: Integer
The grace period before expiring subscribers
integrationOwner :: User
The user of the integration
integrationAccount :: IntegrationAccount
The account the integration links to
integrationSync :: UTCTime
When the integration was last synced

Instances

Instances details

FromJSON Integration Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser Integration # parseJSONList :: Value -> Parser [Integration] # omittedField :: Maybe Integration #
Read Integration Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS Integration # readList :: ReadS [Integration] # readPrec :: ReadPrec Integration # readListPrec :: ReadPrec [Integration] #
Show Integration Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> Integration -> ShowS # show :: Integration -> String # showList :: [Integration] -> ShowS #
Eq Integration Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: Integration -> Integration -> Bool # (/=) :: Integration -> Integration -> Bool #
Ord Integration Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: Integration -> Integration -> Ordering # (<) :: Integration -> Integration -> Bool # (<=) :: Integration -> Integration -> Bool # (>) :: Integration -> Integration -> Bool # (>=) :: Integration -> Integration -> Bool # max :: Integration -> Integration -> Integration # min :: Integration -> Integration -> Integration #

data IntegrationAccount Source #

Represents a third party account link.

Constructors

IntegrationAccount
Fields accountId :: Text The id of the account. accountName :: Text The name of the account.

Instances

Instances details

FromJSON IntegrationAccount Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser IntegrationAccount # parseJSONList :: Value -> Parser [IntegrationAccount] # omittedField :: Maybe IntegrationAccount #
Read IntegrationAccount Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS IntegrationAccount # readList :: ReadS [IntegrationAccount] # readPrec :: ReadPrec IntegrationAccount # readListPrec :: ReadPrec [IntegrationAccount] #
Show IntegrationAccount Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> IntegrationAccount -> ShowS # show :: IntegrationAccount -> String # showList :: [IntegrationAccount] -> ShowS #
Eq IntegrationAccount Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: IntegrationAccount -> IntegrationAccount -> Bool # (/=) :: IntegrationAccount -> IntegrationAccount -> Bool #
Ord IntegrationAccount Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: IntegrationAccount -> IntegrationAccount -> Ordering # (<) :: IntegrationAccount -> IntegrationAccount -> Bool # (<=) :: IntegrationAccount -> IntegrationAccount -> Bool # (>) :: IntegrationAccount -> IntegrationAccount -> Bool # (>=) :: IntegrationAccount -> IntegrationAccount -> Bool # max :: IntegrationAccount -> IntegrationAccount -> IntegrationAccount # min :: IntegrationAccount -> IntegrationAccount -> IntegrationAccount #

data GuildWidget Source #

Represents an image to be used in third party sites to link to a discord channel

Constructors

GuildWidget
Fields widgetEnabled :: Bool Whether the widget is enabled widgetChannelId :: ChannelId The widget channel id

Instances

Instances details

FromJSON GuildWidget Source #
Instance details Defined in Discord.Internal.Types.Guild Methods parseJSON :: Value -> Parser GuildWidget # parseJSONList :: Value -> Parser [GuildWidget] # omittedField :: Maybe GuildWidget #
ToJSON GuildWidget Source #
Instance details Defined in Discord.Internal.Types.Guild Methods toJSON :: GuildWidget -> Value # toEncoding :: GuildWidget -> Encoding # toJSONList :: [GuildWidget] -> Value # toEncodingList :: [GuildWidget] -> Encoding # omitField :: GuildWidget -> Bool #
Read GuildWidget Source #
Instance details Defined in Discord.Internal.Types.Guild Methods readsPrec :: Int -> ReadS GuildWidget # readList :: ReadS [GuildWidget] # readPrec :: ReadPrec GuildWidget # readListPrec :: ReadPrec [GuildWidget] #
Show GuildWidget Source #
Instance details Defined in Discord.Internal.Types.Guild Methods showsPrec :: Int -> GuildWidget -> ShowS # show :: GuildWidget -> String # showList :: [GuildWidget] -> ShowS #
Eq GuildWidget Source #
Instance details Defined in Discord.Internal.Types.Guild Methods (==) :: GuildWidget -> GuildWidget -> Bool # (/=) :: GuildWidget -> GuildWidget -> Bool #
Ord GuildWidget Source #
Instance details Defined in Discord.Internal.Types.Guild Methods compare :: GuildWidget -> GuildWidget -> Ordering # (<) :: GuildWidget -> GuildWidget -> Bool # (<=) :: GuildWidget -> GuildWidget -> Bool # (>) :: GuildWidget -> GuildWidget -> Bool # (>=) :: GuildWidget -> GuildWidget -> Bool # max :: GuildWidget -> GuildWidget -> GuildWidget # min :: GuildWidget -> GuildWidget -> GuildWidget #

Key	Shortcut
s	Open this search box
esc	Close this search box
↓,ctrl + j	Move down in search results
↑,ctrl + k	Move up in search results
↵	Go to active search result