Copyright	(c) Will Sewell, 2016
License	MIT
Maintainer	[email protected]
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 ChannelInfo Source #

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

Constructors

ChannelInfo
Fields channelInfoUserCount :: Maybe Int

Instances

Eq ChannelInfo Source #
Methods (==) :: ChannelInfo -> ChannelInfo -> Bool # (/=) :: ChannelInfo -> ChannelInfo -> Bool #
Show ChannelInfo Source #
Methods showsPrec :: Int -> ChannelInfo -> ShowS # show :: ChannelInfo -> String # showList :: [ChannelInfo] -> ShowS #
FromJSON ChannelInfo Source #
Methods parseJSON :: Value -> Parser ChannelInfo # parseJSONList :: Value -> Parser [ChannelInfo] #

data ChannelInfoAttributes Source #

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

Constructors

ChannelUserCount
ChannelSubscriptionCount

Instances

Eq ChannelInfoAttributes Source #
Methods (==) :: ChannelInfoAttributes -> ChannelInfoAttributes -> Bool # (/=) :: ChannelInfoAttributes -> ChannelInfoAttributes -> Bool #
Generic ChannelInfoAttributes Source #
Associated Types type Rep ChannelInfoAttributes :: * -> * # Methods from :: ChannelInfoAttributes -> Rep ChannelInfoAttributes x # to :: Rep ChannelInfoAttributes x -> ChannelInfoAttributes #
Hashable ChannelInfoAttributes Source #
Methods hashWithSalt :: Int -> ChannelInfoAttributes -> Int # hash :: ChannelInfoAttributes -> Int #
ToURLParam ChannelInfoAttributes Source #
Methods toURLParam :: ChannelInfoAttributes -> Text Source #
type Rep ChannelInfoAttributes Source #
type Rep ChannelInfoAttributes = D1 (MetaData "ChannelInfoAttributes" "Network.Pusher.Protocol" "pusher-http-haskell-1.1.0.3-Eyi5gYKoUId6EX7SeljCyS" False) ((:+:) (C1 (MetaCons "ChannelUserCount" PrefixI False) U1) (C1 (MetaCons "ChannelSubscriptionCount" PrefixI False) U1))

newtype ChannelInfoQuery Source #

A set of requested ChannelInfoAttributes.

Constructors

ChannelInfoQuery (HashSet ChannelInfoAttributes)

Instances

ToURLParam ChannelInfoQuery Source #
Methods toURLParam :: ChannelInfoQuery -> Text Source #

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 #
Methods (==) :: ChannelsInfo -> ChannelsInfo -> Bool # (/=) :: ChannelsInfo -> ChannelsInfo -> Bool #
Show ChannelsInfo Source #
Methods showsPrec :: Int -> ChannelsInfo -> ShowS # show :: ChannelsInfo -> String # showList :: [ChannelsInfo] -> ShowS #
FromJSON ChannelsInfo Source #
Methods parseJSON :: Value -> Parser ChannelsInfo # parseJSONList :: Value -> Parser [ChannelsInfo] #

newtype ChannelsInfoQuery Source #

A set of requested ChannelsInfoAttributes.

Constructors

ChannelsInfoQuery (HashSet ChannelsInfoAttributes)

Instances

ToURLParam ChannelsInfoQuery Source #
Methods toURLParam :: ChannelsInfoQuery -> Text Source #

data ChannelsInfoAttributes Source #

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

Constructors

ChannelsUserCount

Instances

Eq ChannelsInfoAttributes Source #
Methods (==) :: ChannelsInfoAttributes -> ChannelsInfoAttributes -> Bool # (/=) :: ChannelsInfoAttributes -> ChannelsInfoAttributes -> Bool #
Generic ChannelsInfoAttributes Source #
Associated Types type Rep ChannelsInfoAttributes :: * -> * # Methods from :: ChannelsInfoAttributes -> Rep ChannelsInfoAttributes x # to :: Rep ChannelsInfoAttributes x -> ChannelsInfoAttributes #
Hashable ChannelsInfoAttributes Source #
Methods hashWithSalt :: Int -> ChannelsInfoAttributes -> Int # hash :: ChannelsInfoAttributes -> Int #
ToURLParam ChannelsInfoAttributes Source #
Methods toURLParam :: ChannelsInfoAttributes -> Text Source #
type Rep ChannelsInfoAttributes Source #
type Rep ChannelsInfoAttributes = D1 (MetaData "ChannelsInfoAttributes" "Network.Pusher.Protocol" "pusher-http-haskell-1.1.0.3-Eyi5gYKoUId6EX7SeljCyS" False) (C1 (MetaCons "ChannelsUserCount" PrefixI False) U1)

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 #
Methods (==) :: FullChannelInfo -> FullChannelInfo -> Bool # (/=) :: FullChannelInfo -> FullChannelInfo -> Bool #
Show FullChannelInfo Source #
Methods showsPrec :: Int -> FullChannelInfo -> ShowS # show :: FullChannelInfo -> String # showList :: [FullChannelInfo] -> ShowS #
FromJSON FullChannelInfo Source #
Methods parseJSON :: Value -> Parser FullChannelInfo # parseJSONList :: Value -> Parser [FullChannelInfo] #

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 #
Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Show User Source #
Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
FromJSON User Source #
Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #

newtype Users Source #

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

Constructors

Users [User]

Instances

Eq Users Source #
Methods (==) :: Users -> Users -> Bool # (/=) :: Users -> Users -> Bool #
Show Users Source #
Methods showsPrec :: Int -> Users -> ShowS # show :: Users -> String # showList :: [Users] -> ShowS #
FromJSON Users Source #
Methods parseJSON :: Value -> Parser Users # parseJSONList :: Value -> Parser [Users] #

class ToURLParam a where Source #

Types that can be serialised to a querystring parameter value.

Minimal complete definition

toURLParam

Methods

toURLParam :: a -> Text Source #

Convert the data into a querystring parameter value.

Instances

ToURLParam ChannelInfoQuery Source #
Methods toURLParam :: ChannelInfoQuery -> Text Source #
ToURLParam ChannelInfoAttributes Source #
Methods toURLParam :: ChannelInfoAttributes -> Text Source #
ToURLParam ChannelsInfoQuery Source #
Methods toURLParam :: ChannelsInfoQuery -> Text Source #
ToURLParam ChannelsInfoAttributes Source #
Methods toURLParam :: ChannelsInfoAttributes -> Text Source #
ToURLParam a => ToURLParam (HashSet a) Source #
Methods toURLParam :: HashSet a -> Text Source #

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

Convert the data into a querystring parameter value.