pusher-http-haskell-2.1.0.12: Haskell client library for the Pusher Channels HTTP API
Copyright(c) Will Sewell 2016
LicenseMIT
Maintainerme@willsewell.com
Stabilitystable
Safe HaskellSafe-Inferred
LanguageHaskell2010

Network.Pusher.Protocol

Description

Types representing the JSON format of Pusher messages.

There are also types for query string parameters.

Synopsis

Documentation

newtype ChannelInfo Source #

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

Constructors

ChannelInfo 

Instances

Instances details
FromJSON ChannelInfo Source # 
Instance details

Defined in Network.Pusher.Protocol

Show ChannelInfo Source # 
Instance details

Defined in Network.Pusher.Protocol

Eq ChannelInfo Source # 
Instance details

Defined in Network.Pusher.Protocol

data ChannelInfoAttributes Source #

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

Instances

Instances details
Generic ChannelInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

Associated Types

type Rep ChannelInfoAttributes :: Type -> Type #

Eq ChannelInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

Hashable ChannelInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

ToURLParam ChannelInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

type Rep ChannelInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

type Rep ChannelInfoAttributes = D1 ('MetaData "ChannelInfoAttributes" "Network.Pusher.Protocol" "pusher-http-haskell-2.1.0.12-50zE7OTuPAR7bHkfhq8pMt" 'False) (C1 ('MetaCons "ChannelUserCount" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChannelSubscriptionCount" 'PrefixI 'False) (U1 :: Type -> Type))

newtype ChannelInfoQuery Source #

A set of requested ChannelInfoAttributes.

Instances

Instances details
ToURLParam ChannelInfoQuery Source # 
Instance details

Defined in Network.Pusher.Protocol

newtype ChannelsInfo Source #

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

newtype ChannelsInfoQuery Source #

A set of requested ChannelsInfoAttributes.

Instances

Instances details
ToURLParam ChannelsInfoQuery Source # 
Instance details

Defined in Network.Pusher.Protocol

data ChannelsInfoAttributes Source #

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

Constructors

ChannelsUserCount 

Instances

Instances details
Generic ChannelsInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

Associated Types

type Rep ChannelsInfoAttributes :: Type -> Type #

Eq ChannelsInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

Hashable ChannelsInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

ToURLParam ChannelsInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

type Rep ChannelsInfoAttributes Source # 
Instance details

Defined in Network.Pusher.Protocol

type Rep ChannelsInfoAttributes = D1 ('MetaData "ChannelsInfoAttributes" "Network.Pusher.Protocol" "pusher-http-haskell-2.1.0.12-50zE7OTuPAR7bHkfhq8pMt" 'False) (C1 ('MetaCons "ChannelsUserCount" 'PrefixI 'False) (U1 :: Type -> Type))

newtype User Source #

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

Constructors

User 

Fields

Instances

Instances details
FromJSON User Source # 
Instance details

Defined in Network.Pusher.Protocol

Show User Source # 
Instance details

Defined in Network.Pusher.Protocol

Methods

showsPrec :: Int -> User -> ShowS #

show :: User -> String #

showList :: [User] -> ShowS #

Eq User Source # 
Instance details

Defined in Network.Pusher.Protocol

Methods

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

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

newtype Users Source #

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

Constructors

Users [User] 

Instances

Instances details
FromJSON Users Source # 
Instance details

Defined in Network.Pusher.Protocol

Show Users Source # 
Instance details

Defined in Network.Pusher.Protocol

Methods

showsPrec :: Int -> Users -> ShowS #

show :: Users -> String #

showList :: [Users] -> ShowS #

Eq Users Source # 
Instance details

Defined in Network.Pusher.Protocol

Methods

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

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

class ToURLParam a Source #

Types that can be serialised to a querystring parameter value.

Minimal complete definition

toURLParam