| Portability | portable |
|---|---|
| Stability | provisional |
| Maintainer | Michael Xavier <michael@michaelxavier.net> |
Web.Campfire.Types
Description
- data Room = Room {}
- newtype RoomWithRoot = RoomWithRoot {
- unRootRoom :: Room
- newtype Rooms = Rooms {}
- data RoomUpdate = RoomUpdate {}
- data Message = Message {}
- newtype Messages = Messages {
- unMessages :: [Message]
- data MessageType
- data Statement
- = TextStatement { }
- | PasteStatement { }
- | SoundStatement { }
- | TweetStatement {
- statementUrl :: Text
- data Sound
- data User = User {
- userId :: Id
- userName :: Text
- userEmailAddress :: Text
- userAdmin :: Bool
- userCreatedAt :: CampfireTime
- userType :: UserType
- newtype UserWithRoot = UserWithRoot {
- unRootUser :: User
- data UserType
- data Upload = Upload {}
- newtype Uploads = Uploads {}
- newtype UploadWithRoot = UploadWithRoot {}
- type Id = Integer
- newtype CampfireTime = CampfireTime {}
Documentation
A chat room on a Campfire site
Constructors
| Room | |
Fields
| |
newtype RoomWithRoot Source
Utility type used for extracting a Room from the root JSON object the Campfire API returns
Constructors
| RoomWithRoot | |
Fields
| |
Utility type used for extracting a Room from the list returned by the Campfire API
A single line of dialog in a particular chat
Constructors
| Message | |
Fields
| |
Utility type used for extracting a Message from the list returned by the Campfire API
Constructors
| Messages | |
Fields
| |
data MessageType Source
Distinct types of messages which can be found in Campfire
Constructors
| TextMessage | |
| PasteMessage | Monospaced text displayed in block form |
| SoundMessage | Audio sound effect message |
| AdvertisementMessage | |
| AllowGuestsMessage | |
| DisallowGuestsMessage | |
| IdleMessage | |
| KickMessage | Message indicating that a user was kicked out |
| LeaveMessage | |
| SystemMessage | |
| TimestampMessage | |
| TopicChangeMessage | |
| UnidleMessage | |
| UnlockMessage | |
| UploadMessage | |
| EnterMessage |
Statements are messages that you can send to CampFire.
Constructors
| TextStatement | |
Fields | |
| PasteStatement | |
Fields | |
| SoundStatement | Play an audio message in the room |
| TweetStatement | Display a tweet from a url on Twitter |
Fields
| |
Different pre-set sounds that can be played in a room.
User which can be found in any number of rooms.
Constructors
| User | |
Fields
| |
newtype UserWithRoot Source
Utility type used for extracting a User from the root JSON object the Campfire API returns
Constructors
| UserWithRoot | |
Fields
| |
Different classes of users that can be found in chat.
File upload in a room.
Constructors
| Upload | |
Fields
| |
Utility type used for extracting a Upload from the list returned by the Campfire API
newtype UploadWithRoot Source
Utility type used for extracting an Upload from the root JSON object the Campfire API returns
Constructors
| UploadWithRoot | |
Fields | |
newtype CampfireTime Source
Utility type to normalize the non-standard date format that the Campfire API returns
Constructors
| CampfireTime | |
Fields | |