Copyright | (c) Will Sewell 2016 |
---|---|
License | MIT |
Maintainer | me@willsewell.com |
Stability | experimental |
Safe Haskell | None |
Language | Haskell2010 |
Network.Pusher.Protocol
Description
Types representing the JSON format of Pusher messages.
There are also types for query string parameters.
- data ChannelInfo = ChannelInfo {}
- data ChannelInfoAttributes
- newtype ChannelInfoQuery = ChannelInfoQuery (HashSet ChannelInfoAttributes)
- newtype ChannelsInfo = ChannelsInfo (HashMap Channel ChannelInfo)
- newtype ChannelsInfoQuery = ChannelsInfoQuery (HashSet ChannelsInfoAttributes)
- data ChannelsInfoAttributes = ChannelsUserCount
- data FullChannelInfo = FullChannelInfo {}
- data User = User {}
- newtype Users = Users [User]
- class ToURLParam a where
- toURLParam :: ToURLParam a => a -> Text
Documentation
data ChannelInfo #
The possible returned channel attributes when multiple when multiple channels are queried.
Constructors
ChannelInfo | |
Fields |
Instances
data ChannelInfoAttributes #
Enumeration of the attributes that can be queried about a single channel.
Constructors
ChannelUserCount | |
ChannelSubscriptionCount |
newtype ChannelInfoQuery #
A set of requested ChannelInfoAttributes.
Constructors
ChannelInfoQuery (HashSet ChannelInfoAttributes) |
Instances
newtype ChannelsInfo #
A map of channels to their ChannelInfo. The result of querying channel info from multuple channels.
Constructors
ChannelsInfo (HashMap Channel ChannelInfo) |
Instances
newtype ChannelsInfoQuery #
A set of requested ChannelsInfoAttributes.
Constructors
ChannelsInfoQuery (HashSet ChannelsInfoAttributes) |
Instances
data ChannelsInfoAttributes #
Enumeration of the attributes that can be queried about multiple channels.
Constructors
ChannelsUserCount |
data FullChannelInfo #
The possible values returned by a query to a single channel
Constructors
FullChannelInfo | |
Instances
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.
class ToURLParam a where #
Types that can be serialised to a querystring parameter value.
Minimal complete definition
toURLParam :: ToURLParam a => a -> Text #
Convert the data into a querystring parameter value.