Safe Haskell	None
Language	Haskell2010

Discord.Types.Guild

Description

Types relating to Discord Guilds (servers)

Synopsis

data GuildMember = GuildMember {
- memberUser :: User
- memberNick :: Maybe Text
- memberRoles :: [Snowflake]
- memberJoinedAt :: UTCTime
- memberDeaf :: Bool
- memberMute :: Bool
}
data Guild = Guild {
- guildId :: !Snowflake
- guildName :: Text
- guildIcon :: Maybe Text
- guildSplash :: Maybe Text
- guildOwnerId :: !Snowflake
- guildPermissions :: Maybe Integer
- guildRegion :: Text
- guildAfkId :: Maybe Snowflake
- guildAfkTimeout :: !Integer
- guildEmbedEnabled :: Maybe Bool
- guildEmbedChannel :: Maybe Snowflake
- guildVerificationLevel :: !Integer
- guildNotification :: !Integer
- guildExplicitFilterLevel :: !Integer
- guildRoles :: [Role]
- guildEmojis :: [Emoji]
- guildFeatures :: [Text]
- guildMultiFactAuth :: !Integer
- guildApplicationId :: Maybe Snowflake
}
data Unavailable = Unavailable {
- idOnceAvailable :: !Snowflake
}
data GuildInfo = GuildInfo {
- guildJoinedAt :: UTCTime
- guildLarge :: Bool
- guildMemberCount :: Integer
- guildMembers :: [GuildMember]
- guildChannels :: [Channel]
}
data PartialGuild = PartialGuild {
- partialGuildId :: Snowflake
- partialGuildName :: Text
- partialGuildIcon :: Maybe Text
- partialGuildOwner :: Bool
- partialGuildPermissions :: Integer
}
data Emoji = Emoji {
- emojiId :: Maybe Snowflake
- emojiName :: Text
- emojiRoles :: Maybe [Snowflake]
- emojiManaged :: Maybe Bool
}
data Role = Role {
- roleID :: !Snowflake
- roleName :: Text
- roleColor :: Integer
- roleHoist :: Bool
- rolePos :: Integer
- rolePerms :: Integer
- roleManaged :: Bool
- roleMention :: Bool
}
data VoiceRegion = VoiceRegion {
- regionId :: !Snowflake
- regionName :: Text
- regionHostname :: Text
- regionPort :: Int
- regionVip :: Bool
- regionOptimal :: Bool
- regionDepreciated :: Bool
- regionCustom :: Bool
}
data Invite = Invite {
- inviteCode :: Text
- inviteGuild :: !Snowflake
- inviteChan :: !Snowflake
}
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 :: Snowflake
- integrationBehavior :: Integer
- integrationGrace :: Integer
- integrationOwner :: User
- integrationAccount :: IntegrationAccount
- integrationSync :: UTCTime
}
data IntegrationAccount = Account {
- accountId :: Text
- accountName :: Text
}
data GuildEmbed = GuildEmbed {
- embedEnabled :: !Bool
- embedChannel :: !Snowflake
}

Documentation

data GuildMember Source #

Representation of a guild member.

Constructors

GuildMember
Fields memberUser :: User memberNick :: Maybe Text memberRoles :: [Snowflake] memberJoinedAt :: UTCTime memberDeaf :: Bool memberMute :: Bool

Instances

Show GuildMember Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> GuildMember -> ShowS # show :: GuildMember -> String # showList :: [GuildMember] -> ShowS #
FromJSON GuildMember Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser GuildMember # parseJSONList :: Value -> Parser [GuildMember] #

data Guild Source #

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

Constructors

Guild

Fields

guildId :: !Snowflake
Gulid id
guildName :: Text
Guild name (2 - 100 chars)
guildIcon :: Maybe Text
Icon hash
guildSplash :: Maybe Text
Splash hash
guildOwnerId :: !Snowflake
Guild owner id
guildPermissions :: Maybe Integer
guildRegion :: Text
Guild voice region
guildAfkId :: Maybe Snowflake
Id of afk channel
guildAfkTimeout :: !Integer
Afk timeout in seconds
guildEmbedEnabled :: Maybe Bool
Id of embedded channel
guildEmbedChannel :: Maybe Snowflake
Id of embedded channel
guildVerificationLevel :: !Integer
Level of verification
guildNotification :: !Integer
Level of default notifications
guildExplicitFilterLevel :: !Integer
guildRoles :: [Role]
Array of Role objects
guildEmojis :: [Emoji]
Array of Emoji objects
guildFeatures :: [Text]
guildMultiFactAuth :: !Integer
guildApplicationId :: Maybe Snowflake

Instances

Show Guild Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> Guild -> ShowS # show :: Guild -> String # showList :: [Guild] -> ShowS #
FromJSON Guild Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser Guild # parseJSONList :: Value -> Parser [Guild] #

data Unavailable Source #

Constructors

Unavailable
Fields idOnceAvailable :: !Snowflake

Instances

Show Unavailable Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> Unavailable -> ShowS # show :: Unavailable -> String # showList :: [Unavailable] -> ShowS #
FromJSON Unavailable Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser Unavailable # parseJSONList :: Value -> Parser [Unavailable] #

data GuildInfo Source #

Constructors

GuildInfo
Fields guildJoinedAt :: UTCTime guildLarge :: Bool guildMemberCount :: Integer guildMembers :: [GuildMember] guildChannels :: [Channel] Channels in the guild (sent in GuildCreate) , guildPresences :: [Presence]

Instances

Show GuildInfo Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> GuildInfo -> ShowS # show :: GuildInfo -> String # showList :: [GuildInfo] -> ShowS #
FromJSON GuildInfo Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser GuildInfo # parseJSONList :: Value -> Parser [GuildInfo] #

data PartialGuild Source #

Constructors

PartialGuild
Fields partialGuildId :: Snowflake partialGuildName :: Text partialGuildIcon :: Maybe Text partialGuildOwner :: Bool partialGuildPermissions :: Integer

Instances

Show PartialGuild Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> PartialGuild -> ShowS # show :: PartialGuild -> String # showList :: [PartialGuild] -> ShowS #
FromJSON PartialGuild Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser PartialGuild # parseJSONList :: Value -> Parser [PartialGuild] #

data Emoji Source #

Represents an emoticon (emoji)

Constructors

Emoji
Fields emojiId :: Maybe Snowflake The emoji id emojiName :: Text The emoji name emojiRoles :: Maybe [Snowflake] Roles the emoji is active for emojiManaged :: Maybe Bool Whether this emoji is managed

Instances

Show Emoji Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> Emoji -> ShowS # show :: Emoji -> String # showList :: [Emoji] -> ShowS #
FromJSON Emoji Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser Emoji # parseJSONList :: Value -> Parser [Emoji] #

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 :: !Snowflake The role id roleName :: Text The role name roleColor :: Integer Integer representation of color code roleHoist :: Bool If the role is pinned in the user listing rolePos :: Integer Position of this role rolePerms :: Integer Permission bit set roleManaged :: Bool Whether this role is managed by an integration roleMention :: Bool Whether this role is mentionable

Instances

Eq Role Source #
Instance details Defined in Discord.Types.Guild Methods (==) :: Role -> Role -> Bool # (/=) :: Role -> Role -> Bool #
Show Role Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> Role -> ShowS # show :: Role -> String # showList :: [Role] -> ShowS #
FromJSON Role Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser Role # parseJSONList :: Value -> Parser [Role] #

data VoiceRegion Source #

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

Constructors

VoiceRegion

Fields

regionId :: !Snowflake
Unique id of the region
regionName :: Text
Name of the region
regionHostname :: Text
Example hostname for the region
regionPort :: Int
Example port for the region
regionVip :: Bool
True if this is a VIP only server
regionOptimal :: Bool
True for the closest server to a client
regionDepreciated :: Bool
Whether this is a deprecated region
regionCustom :: Bool
Whether this is a custom region

Instances

Show VoiceRegion Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> VoiceRegion -> ShowS # show :: VoiceRegion -> String # showList :: [VoiceRegion] -> ShowS #
FromJSON VoiceRegion Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser VoiceRegion # parseJSONList :: Value -> Parser [VoiceRegion] #

data Invite Source #

Represents a code to add a user to a guild

Constructors

Invite
Fields inviteCode :: Text The invite code inviteGuild :: !Snowflake The guild the code will invite to inviteChan :: !Snowflake The channel the code will invite to

Instances

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

data InviteWithMeta Source #

Invite code with additional metadata

Constructors

InviteWithMeta Invite InviteMeta

Instances

FromJSON InviteWithMeta Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser InviteWithMeta # parseJSONList :: Value -> Parser [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

FromJSON InviteMeta Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser InviteMeta # parseJSONList :: Value -> Parser [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 :: Snowflake
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

Show Integration Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> Integration -> ShowS # show :: Integration -> String # showList :: [Integration] -> ShowS #
FromJSON Integration Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser Integration # parseJSONList :: Value -> Parser [Integration] #

data IntegrationAccount Source #

Represents a third party account link.

Constructors

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

Instances

Show IntegrationAccount Source #
Instance details Defined in Discord.Types.Guild Methods showsPrec :: Int -> IntegrationAccount -> ShowS # show :: IntegrationAccount -> String # showList :: [IntegrationAccount] -> ShowS #
FromJSON IntegrationAccount Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser IntegrationAccount # parseJSONList :: Value -> Parser [IntegrationAccount] #

data GuildEmbed Source #

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

Constructors

GuildEmbed
Fields embedEnabled :: !Bool Whether the embed is enabled embedChannel :: !Snowflake The embed channel id

Instances

ToJSON GuildEmbed Source #
Instance details Defined in Discord.Types.Guild Methods toJSON :: GuildEmbed -> Value # toEncoding :: GuildEmbed -> Encoding # toJSONList :: [GuildEmbed] -> Value # toEncodingList :: [GuildEmbed] -> Encoding #
FromJSON GuildEmbed Source #
Instance details Defined in Discord.Types.Guild Methods parseJSON :: Value -> Parser GuildEmbed # parseJSONList :: Value -> Parser [GuildEmbed] #