Copyright | (c) Will Sewell, 2015 |
---|---|
License | MIT |
Maintainer | me@willsewell.com |
Stability | experimental |
Safe Haskell | None |
Language | Haskell2010 |
Types representing the JSON format of Pusher messages.
There are also types for query string parameters.
- data Channel = Channel {}
- newtype ChannelInfo = ChannelInfo (HashSet ChannelInfoAttributeResp)
- data ChannelInfoAttributes
- data ChannelInfoAttributeResp = UserCountResp Int
- newtype ChannelInfoQuery = ChannelInfoQuery (HashSet ChannelInfoAttributes)
- newtype ChannelsInfo = ChannelsInfo (HashMap Channel ChannelInfo)
- newtype ChannelsInfoQuery = ChannelsInfoQuery (HashSet ChannelsInfoAttributes)
- data ChannelsInfoAttributes = ChannelsUserCount
- data ChannelType
- newtype FullChannelInfo = FullChannelInfo (HashSet FullChannelAttributeResp)
- data FullChannelAttributeResp
- data User = User {}
- newtype Users = Users [User]
- parseChannel :: Text -> Channel
- toURLParam :: ToURLParam a => a -> Text
Documentation
The channel name (not including the channel type prefix) and its type.
newtype ChannelInfo Source
A set of returned channel attributes for a single channel.
data ChannelInfoAttributes Source
Enumeration of the attributes that can be queried about a single channel.
data ChannelInfoAttributeResp Source
An enumeration of possible returned channel attributes when multiple when multiple channels are queried.
newtype ChannelInfoQuery Source
A set of requested ChannelInfoAttributes.
newtype ChannelsInfo Source
A map of channels to their ChannelInfo. The result of querying channel info from multuple channels.
newtype ChannelsInfoQuery Source
A set of requested ChannelsInfoAttributes.
data ChannelsInfoAttributes Source
Enumeration of the attributes that can be queried about multiple channels.
data ChannelType Source
The possible types of Pusher channe.
newtype FullChannelInfo Source
A set of returned channel attributes for a single channel.
data FullChannelAttributeResp Source
An enumeration of possible returned channel attributes when a single channel is queried
The data about a user returned when querying for users in a presence channel.
A list of users returned by querying for users in a presence channel.
parseChannel :: Text -> Channel Source
Convert string representation, e.g. private-chan into the datatype
toURLParam :: ToURLParam a => a -> Text Source
Convert the data into a querystring parameter value.