| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Discord.Internal.Types.ScheduledEvents
Description
Structures pertaining to Discord Scheduled Events
Synopsis
- data ScheduledEvent
- = ScheduledEventStage {
- scheduledEventStageId :: ScheduledEventId
- scheduledEventStageGuildId :: GuildId
- scheduledEventStageChannelId :: ChannelId
- scheduledEventStageCreatorId :: Maybe UserId
- scheduledEventStageName :: Text
- scheduledEventStageDescription :: Maybe Text
- scheduledEventStageStartTime :: UTCTime
- scheduledEventStageEndTime :: Maybe UTCTime
- scheduledEventStagePrivacyLevel :: ScheduledEventPrivacyLevel
- scheduledEventStageStatus :: ScheduledEventStatus
- scheduledEventStageEntityId :: Maybe ScheduledEventEntityId
- scheduledEventStageCreator :: Maybe User
- scheduledEventStageUserCount :: Maybe Integer
- scheduledEventStageImage :: Maybe ScheduledEventImageHash
- | ScheduledEventVoice {
- scheduledEventVoiceId :: ScheduledEventId
- scheduledEventVoiceGuildId :: GuildId
- scheduledEventVoiceChannelId :: ChannelId
- scheduledEventVoiceCreatorId :: Maybe UserId
- scheduledEventVoiceName :: Text
- scheduledEventVoiceDescription :: Maybe Text
- scheduledEventVoiceStartTime :: UTCTime
- scheduledEventVoiceEndTime :: Maybe UTCTime
- scheduledEventVoicePrivacyLevel :: ScheduledEventPrivacyLevel
- scheduledEventVoiceStatus :: ScheduledEventStatus
- scheduledEventVoiceEntityId :: Maybe ScheduledEventEntityId
- scheduledEventVoiceCreator :: Maybe User
- scheduledEventVoiceUserCount :: Maybe Integer
- scheduledEventVoiceImage :: Maybe ScheduledEventImageHash
- | ScheduledEventExternal {
- scheduledEventExternalId :: ScheduledEventId
- scheduledEventExternalGuildId :: GuildId
- scheduledEventExternalLocation :: Text
- scheduledEventExternalCreatorId :: Maybe UserId
- scheduledEventExternalName :: Text
- scheduledEventExternalDescription :: Maybe Text
- scheduledEventExternalStartTime :: UTCTime
- scheduledEventExternalEndTime :: UTCTime
- scheduledEventExternalPrivacyLevel :: ScheduledEventPrivacyLevel
- scheduledEventExternalStatus :: ScheduledEventStatus
- scheduledEventExternalEntityId :: Maybe ScheduledEventEntityId
- scheduledEventExternalCreator :: Maybe User
- scheduledEventExternalUserCount :: Maybe Integer
- scheduledEventExternalImage :: Maybe ScheduledEventImageHash
- = ScheduledEventStage {
- data ScheduledEventPrivacyLevel = ScheduledEventPrivacyLevelGuildOnly
- data ScheduledEventStatus
- type ScheduledEventImageHash = Text
- data CreateScheduledEventImageUploadType
- data CreateScheduledEventImage
- data CreateScheduledEventData
- = CreateScheduledEventDataStage {
- createScheduleEventDataStageChannelId :: ChannelId
- createScheduleEventDataStageName :: Text
- createScheduleEventDataStagePrivacyLevel :: ScheduledEventPrivacyLevel
- createScheduleEventDataStageStartTime :: UTCTime
- createScheduleEventDataStageEndTime :: Maybe UTCTime
- createScheduleEventDataStageDescription :: Maybe Text
- createScheduleEventDataStageImage :: Maybe CreateScheduledEventImage
- | CreateScheduledEventDataVoice {
- createScheduleEventDataVoiceChannelId :: ChannelId
- createScheduleEventDataVoiceName :: Text
- createScheduleEventDataVoicePrivacyLevel :: ScheduledEventPrivacyLevel
- createScheduleEventDataVoiceStartTime :: UTCTime
- createScheduleEventDataVoiceEndTime :: Maybe UTCTime
- createScheduleEventDataVoiceDescription :: Maybe Text
- createScheduleEventDataVoiceImage :: Maybe CreateScheduledEventImage
- | CreateScheduledEventDataExternal {
- createScheduleEventDataExternalLocation :: Text
- createScheduleEventDataExternalName :: Text
- createScheduleEventDataExternalPrivacyLevel :: ScheduledEventPrivacyLevel
- createScheduleEventDataExternalStartTime :: UTCTime
- createScheduleEventDataExternalEndTime :: UTCTime
- createScheduleEventDataExternalDescription :: Maybe Text
- createScheduleEventDataExternalImage :: Maybe CreateScheduledEventImage
- = CreateScheduledEventDataStage {
- data ScheduledEventType
- data ModifyScheduledEventData = ModifyScheduledEventData {
- modifyScheduledEventDataChannelId :: Maybe (Maybe ChannelId)
- modifyScheduledEventDataLocation :: Maybe (Maybe Text)
- modifyScheduledEventDataName :: Maybe Text
- modifyScheduledEventDataPrivacyLevel :: Maybe ScheduledEventPrivacyLevel
- modifyScheduledEventDataStartTime :: Maybe UTCTime
- modifyScheduledEventDataEndTime :: Maybe UTCTime
- modifyScheduledEventDataDescription :: Maybe (Maybe Text)
- modifyScheduledEventDataType :: Maybe ScheduledEventType
- modifyScheduledEventDataStatus :: Maybe ScheduledEventStatus
- modifyScheduledEventDataImage :: Maybe CreateScheduledEventImage
- data ScheduledEventUser = ScheduledEventUser {}
Documentation
data ScheduledEvent Source #
The ScheduledEvent data structure
Constructors
Instances
| ToJSON ScheduledEvent Source # | |
Defined in Discord.Internal.Types.ScheduledEvents Methods toJSON :: ScheduledEvent -> Value # toEncoding :: ScheduledEvent -> Encoding # toJSONList :: [ScheduledEvent] -> Value # toEncodingList :: [ScheduledEvent] -> Encoding # | |
| FromJSON ScheduledEvent Source # | |
Defined in Discord.Internal.Types.ScheduledEvents Methods parseJSON :: Value -> Parser ScheduledEvent # parseJSONList :: Value -> Parser [ScheduledEvent] # | |
data ScheduledEventPrivacyLevel Source #
The privacy level of a scheduled event
Constructors
| ScheduledEventPrivacyLevelGuildOnly |
Instances
data ScheduledEventStatus Source #
The Status of a Scheduled Event
Constructors
| ScheduledEventStatusScheduled | |
| ScheduledEventStatusActive | |
| ScheduledEventStatusCompleted | |
| ScheduledEventStatusCancelled |
Instances
type ScheduledEventImageHash = Text Source #
The hash of the cover image of a ScheduledEvent
data CreateScheduledEventImageUploadType Source #
The type of images that can be uploaded
Constructors
| CreateScheduledEventImageUploadTypeJPG | |
| CreateScheduledEventImageUploadTypePNG | |
| CreateScheduledEventImageUploadTypeGIF |
Instances
data CreateScheduledEventImage Source #
The required information to add a cover image to a Scheduled Event
Constructors
| CreateScheduledEventImageURL Text | |
| CreateScheduledEventImageUpload CreateScheduledEventImageUploadType ByteString |
Instances
data CreateScheduledEventData Source #
Data required to create a Scheduled Event
Constructors
Instances
| ToJSON CreateScheduledEventData Source # | |
Defined in Discord.Internal.Types.ScheduledEvents Methods toJSON :: CreateScheduledEventData -> Value # toEncoding :: CreateScheduledEventData -> Encoding # toJSONList :: [CreateScheduledEventData] -> Value # | |
| FromJSON CreateScheduledEventData Source # | |
Defined in Discord.Internal.Types.ScheduledEvents Methods parseJSON :: Value -> Parser CreateScheduledEventData # parseJSONList :: Value -> Parser [CreateScheduledEventData] # | |
data ScheduledEventType Source #
The type of ScheduledEvent, used in ModifyScheduledEventData
Instances
data ModifyScheduledEventData Source #
Data required to issue a Modify Scheduled Event request This isnt fully type-safe, and can allow for boggus requests but I don't know of any sane solution to this
Constructors
Instances
| ToJSON ModifyScheduledEventData Source # | |
Defined in Discord.Internal.Types.ScheduledEvents Methods toJSON :: ModifyScheduledEventData -> Value # toEncoding :: ModifyScheduledEventData -> Encoding # toJSONList :: [ModifyScheduledEventData] -> Value # | |
| FromJSON ModifyScheduledEventData Source # | |
Defined in Discord.Internal.Types.ScheduledEvents Methods parseJSON :: Value -> Parser ModifyScheduledEventData # parseJSONList :: Value -> Parser [ModifyScheduledEventData] # | |
| Default ModifyScheduledEventData Source # | |
Defined in Discord.Internal.Types.ScheduledEvents Methods | |
data ScheduledEventUser Source #
An User that subscribed to a Scheduled Event
Constructors
| ScheduledEventUser | |
Instances
| FromJSON ScheduledEventUser Source # | |
Defined in Discord.Internal.Types.ScheduledEvents Methods parseJSON :: Value -> Parser ScheduledEventUser # parseJSONList :: Value -> Parser [ScheduledEventUser] # | |