Copyright	(c) Will Sewell, 2015
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.

Synopsis

Documentation

data Channel Source

The channel name (not including the channel type prefix) and its type.

Constructors

Channel
Fields channelType :: ChannelType channelName :: Text

Instances

Eq Channel Source
Show Channel Source
Generic Channel Source
Arbitrary Channel Source
Hashable Channel Source
type Rep Channel Source

data ChannelInfo Source

The possible returned channel attributes when multiple when multiple channels are queried.

Constructors

ChannelInfo
Fields channelInfoUserCount :: Maybe Int

Instances

Eq ChannelInfo Source
Show ChannelInfo Source
FromJSON ChannelInfo Source

data ChannelInfoAttributes Source

Enumeration of the attributes that can be queried about a single channel.

Constructors

ChannelUserCount
ChannelSubscriptionCount

Instances

Eq ChannelInfoAttributes Source
Generic ChannelInfoAttributes Source
Hashable ChannelInfoAttributes Source
type Rep ChannelInfoAttributes Source

newtype ChannelInfoQuery Source

A set of requested ChannelInfoAttributes.

Constructors

ChannelInfoQuery (HashSet ChannelInfoAttributes)

newtype ChannelsInfo Source

A map of channels to their ChannelInfo. The result of querying channel info from multuple channels.

Constructors

ChannelsInfo (HashMap Channel ChannelInfo)

Instances

Eq ChannelsInfo Source
Show ChannelsInfo Source
FromJSON ChannelsInfo Source

newtype ChannelsInfoQuery Source

A set of requested ChannelsInfoAttributes.

Constructors

ChannelsInfoQuery (HashSet ChannelsInfoAttributes)

data ChannelsInfoAttributes Source

Enumeration of the attributes that can be queried about multiple channels.

Constructors

ChannelsUserCount

Instances

Eq ChannelsInfoAttributes Source
Generic ChannelsInfoAttributes Source
Hashable ChannelsInfoAttributes Source
type Rep ChannelsInfoAttributes Source

data ChannelType Source

The possible types of Pusher channe.

Constructors

Public
Private
Presence

Instances

Eq ChannelType Source
Show ChannelType Source
Generic ChannelType Source
Arbitrary ChannelType Source
Hashable ChannelType Source
type Rep ChannelType Source

data FullChannelInfo Source

The possible values returned by a query to a single channel

Constructors

FullChannelInfo
Fields fullChannelInfoOccupied :: Bool fullChannelInfoUserCount :: Maybe Int fullChannelInfoSubCount :: Maybe Int

Instances

Eq FullChannelInfo Source
Show FullChannelInfo Source
FromJSON FullChannelInfo Source

data User Source

The data about a user returned when querying for users in a presence channel.

Constructors

User
Fields userID :: Text

Instances

Eq User Source
Show User Source
FromJSON User Source

newtype Users Source

A list of users returned by querying for users in a presence channel.

Constructors

Users [User]

Instances

Eq Users Source
Show Users Source
FromJSON Users Source

parseChannel :: Text -> Channel Source

Convert string representation, e.g. private-chan into the datatype

renderChannel :: Channel -> Text Source

renderChannelPrefix :: ChannelType -> Text Source

toURLParam :: ToURLParam a => a -> Text Source

Convert the data into a querystring parameter value.