pusher-http-haskell-1.2.0.1: Haskell client library for the Pusher HTTP API

Copyright(c) Will Sewell 2016
LicenseMIT
Maintainerme@willsewell.com
Stabilityexperimental
Safe HaskellNone
LanguageHaskell2010

Network.Pusher.Protocol

Description

Types representing the JSON format of Pusher messages.

There are also types for query string parameters.

Synopsis

Documentation

data ChannelInfo #

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

Constructors

ChannelInfo 

data ChannelInfoAttributes #

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

newtype ChannelInfoQuery #

A set of requested ChannelInfoAttributes.

newtype ChannelsInfo #

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

newtype ChannelsInfoQuery #

A set of requested ChannelsInfoAttributes.

data ChannelsInfoAttributes #

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

Constructors

ChannelsUserCount 

data User #

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

Constructors

User 

Fields

Instances

Eq User # 

Methods

(==) :: User -> User -> Bool #

(/=) :: User -> User -> Bool #

Show User # 

Methods

showsPrec :: Int -> User -> ShowS #

show :: User -> String #

showList :: [User] -> ShowS #

FromJSON User # 

newtype Users #

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

Constructors

Users [User] 

Instances

class ToURLParam a where #

Types that can be serialised to a querystring parameter value.

Minimal complete definition

toURLParam

Methods

toURLParam :: a -> Text #

Convert the data into a querystring parameter value.

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

Convert the data into a querystring parameter value.