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.

Synopsis

newtype ChannelInfo = ChannelInfo {
- channelInfoUserCount :: Maybe Int
}
data ChannelInfoAttributes
- = ChannelUserCount
- | ChannelSubscriptionCount
newtype ChannelInfoQuery = ChannelInfoQuery (HashSet ChannelInfoAttributes)
newtype ChannelsInfo = ChannelsInfo (HashMap Channel ChannelInfo)
newtype ChannelsInfoQuery = ChannelsInfoQuery (HashSet ChannelsInfoAttributes)
data ChannelsInfoAttributes = ChannelsUserCount
data FullChannelInfo = FullChannelInfo {
- fullChannelInfoOccupied :: Bool
- fullChannelInfoUserCount :: Maybe Int
- fullChannelInfoSubCount :: Maybe Int
}
newtype User = User {
- userID :: Text
}
newtype Users = Users [User]
class ToURLParam a
toURLParam :: ToURLParam a => a -> Text

Documentation

newtype ChannelInfo #

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

Constructors

ChannelInfo
Fields channelInfoUserCount :: Maybe Int

Instances

Eq ChannelInfo #
Instance details Defined in Network.Pusher.Protocol Methods (==) :: ChannelInfo -> ChannelInfo -> Bool # (/=) :: ChannelInfo -> ChannelInfo -> Bool #
Show ChannelInfo #
Instance details Defined in Network.Pusher.Protocol Methods showsPrec :: Int -> ChannelInfo -> ShowS # show :: ChannelInfo -> String # showList :: [ChannelInfo] -> ShowS #
FromJSON ChannelInfo #
Instance details Defined in Network.Pusher.Protocol Methods parseJSON :: Value -> Parser ChannelInfo # parseJSONList :: Value -> Parser [ChannelInfo] #

data ChannelInfoAttributes #

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

Constructors

ChannelUserCount
ChannelSubscriptionCount

Instances

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

newtype ChannelInfoQuery #

A set of requested ChannelInfoAttributes.

Constructors

ChannelInfoQuery (HashSet ChannelInfoAttributes)

Instances

ToURLParam ChannelInfoQuery #
Instance details Defined in Network.Pusher.Protocol Methods toURLParam :: ChannelInfoQuery -> Text #

newtype ChannelsInfo #

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

Constructors

ChannelsInfo (HashMap Channel ChannelInfo)

Instances

Eq ChannelsInfo #
Instance details Defined in Network.Pusher.Protocol Methods (==) :: ChannelsInfo -> ChannelsInfo -> Bool # (/=) :: ChannelsInfo -> ChannelsInfo -> Bool #
Show ChannelsInfo #
Instance details Defined in Network.Pusher.Protocol Methods showsPrec :: Int -> ChannelsInfo -> ShowS # show :: ChannelsInfo -> String # showList :: [ChannelsInfo] -> ShowS #
FromJSON ChannelsInfo #
Instance details Defined in Network.Pusher.Protocol Methods parseJSON :: Value -> Parser ChannelsInfo # parseJSONList :: Value -> Parser [ChannelsInfo] #

newtype ChannelsInfoQuery #

A set of requested ChannelsInfoAttributes.

Constructors

ChannelsInfoQuery (HashSet ChannelsInfoAttributes)

Instances

ToURLParam ChannelsInfoQuery #
Instance details Defined in Network.Pusher.Protocol Methods toURLParam :: ChannelsInfoQuery -> Text #

data ChannelsInfoAttributes #

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

Constructors

ChannelsUserCount

Instances

Eq ChannelsInfoAttributes #
Instance details Defined in Network.Pusher.Protocol Methods (==) :: ChannelsInfoAttributes -> ChannelsInfoAttributes -> Bool # (/=) :: ChannelsInfoAttributes -> ChannelsInfoAttributes -> Bool #
Generic ChannelsInfoAttributes #
Instance details Defined in Network.Pusher.Protocol Associated Types type Rep ChannelsInfoAttributes :: Type -> Type # Methods from :: ChannelsInfoAttributes -> Rep ChannelsInfoAttributes x # to :: Rep ChannelsInfoAttributes x -> ChannelsInfoAttributes #
Hashable ChannelsInfoAttributes #
Instance details Defined in Network.Pusher.Protocol Methods hashWithSalt :: Int -> ChannelsInfoAttributes -> Int # hash :: ChannelsInfoAttributes -> Int #
ToURLParam ChannelsInfoAttributes #
Instance details Defined in Network.Pusher.Protocol Methods toURLParam :: ChannelsInfoAttributes -> Text #
type Rep ChannelsInfoAttributes #
Instance details Defined in Network.Pusher.Protocol type Rep ChannelsInfoAttributes = D1 (MetaData "ChannelsInfoAttributes" "Network.Pusher.Protocol" "pusher-http-haskell-1.5.1.7-BDxJtMce7w7EFcJboqW02P" False) (C1 (MetaCons "ChannelsUserCount" PrefixI False) (U1 :: Type -> Type))

data FullChannelInfo #

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 #
Instance details Defined in Network.Pusher.Protocol Methods (==) :: FullChannelInfo -> FullChannelInfo -> Bool # (/=) :: FullChannelInfo -> FullChannelInfo -> Bool #
Show FullChannelInfo #
Instance details Defined in Network.Pusher.Protocol Methods showsPrec :: Int -> FullChannelInfo -> ShowS # show :: FullChannelInfo -> String # showList :: [FullChannelInfo] -> ShowS #
FromJSON FullChannelInfo #
Instance details Defined in Network.Pusher.Protocol Methods parseJSON :: Value -> Parser FullChannelInfo # parseJSONList :: Value -> Parser [FullChannelInfo] #

newtype User #

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

Constructors

User
Fields userID :: Text

Instances

Eq User #
Instance details Defined in Network.Pusher.Protocol Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Show User #
Instance details Defined in Network.Pusher.Protocol Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
FromJSON User #
Instance details Defined in Network.Pusher.Protocol Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #

newtype Users #

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

Constructors

Users [User]

Instances

Eq Users #
Instance details Defined in Network.Pusher.Protocol Methods (==) :: Users -> Users -> Bool # (/=) :: Users -> Users -> Bool #
Show Users #
Instance details Defined in Network.Pusher.Protocol Methods showsPrec :: Int -> Users -> ShowS # show :: Users -> String # showList :: [Users] -> ShowS #
FromJSON Users #
Instance details Defined in Network.Pusher.Protocol Methods parseJSON :: Value -> Parser Users # parseJSONList :: Value -> Parser [Users] #

class ToURLParam a #

Types that can be serialised to a querystring parameter value.

Minimal complete definition

toURLParam

Instances

ToURLParam ChannelInfoQuery #
Instance details Defined in Network.Pusher.Protocol Methods toURLParam :: ChannelInfoQuery -> Text #
ToURLParam ChannelInfoAttributes #
Instance details Defined in Network.Pusher.Protocol Methods toURLParam :: ChannelInfoAttributes -> Text #
ToURLParam ChannelsInfoQuery #
Instance details Defined in Network.Pusher.Protocol Methods toURLParam :: ChannelsInfoQuery -> Text #
ToURLParam ChannelsInfoAttributes #
Instance details Defined in Network.Pusher.Protocol Methods toURLParam :: ChannelsInfoAttributes -> Text #
ToURLParam a => ToURLParam (HashSet a) #
Instance details Defined in Network.Pusher.Protocol Methods toURLParam :: HashSet a -> Text #

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