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

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

Constructors

ChannelInfo
Fields channelInfoUserCount :: Maybe Int

Instances

Instances details

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

data ChannelInfoAttributes Source #

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

Constructors

ChannelUserCount
ChannelSubscriptionCount

Instances

Instances details

Generic ChannelInfoAttributes Source #

Instance details

Defined in Network.Pusher.Protocol

Associated Types

type Rep ChannelInfoAttributes
Instance details Defined in Network.Pusher.Protocol type Rep ChannelInfoAttributes = D1 ('MetaData "ChannelInfoAttributes" "Network.Pusher.Protocol" "pusher-http-haskell-2.1.0.20-EO7SDYLwc3i8qsaAA7kRsy" 'False) (C1 ('MetaCons "ChannelUserCount" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChannelSubscriptionCount" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: ChannelInfoAttributes -> Rep ChannelInfoAttributes x #

to :: Rep ChannelInfoAttributes x -> ChannelInfoAttributes #

Eq ChannelInfoAttributes Source #

Instance details

Defined in Network.Pusher.Protocol

Methods

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

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

Hashable ChannelInfoAttributes Source #

Instance details

Defined in Network.Pusher.Protocol

Methods

hashWithSalt :: Int -> ChannelInfoAttributes -> Int #

hash :: ChannelInfoAttributes -> Int #

ToURLParam ChannelInfoAttributes Source #

Instance details

Defined in Network.Pusher.Protocol

Methods

toURLParam :: ChannelInfoAttributes -> Text Source #

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.20-EO7SDYLwc3i8qsaAA7kRsy" '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.

Constructors

ChannelInfoQuery (HashSet ChannelInfoAttributes)

Instances

Instances details

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

newtype ChannelsInfo Source #

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

Constructors

ChannelsInfo (HashMap Text ChannelInfo)

Instances

Instances details

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

newtype ChannelsInfoQuery Source #

A set of requested ChannelsInfoAttributes.

Constructors

ChannelsInfoQuery (HashSet ChannelsInfoAttributes)

Instances

Instances details

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

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
Instance details Defined in Network.Pusher.Protocol type Rep ChannelsInfoAttributes = D1 ('MetaData "ChannelsInfoAttributes" "Network.Pusher.Protocol" "pusher-http-haskell-2.1.0.20-EO7SDYLwc3i8qsaAA7kRsy" 'False) (C1 ('MetaCons "ChannelsUserCount" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: ChannelsInfoAttributes -> Rep ChannelsInfoAttributes x #

to :: Rep ChannelsInfoAttributes x -> ChannelsInfoAttributes #

Eq ChannelsInfoAttributes Source #

Instance details

Defined in Network.Pusher.Protocol

Methods

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

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

Hashable ChannelsInfoAttributes Source #

Instance details

Defined in Network.Pusher.Protocol

Methods

hashWithSalt :: Int -> ChannelsInfoAttributes -> Int #

hash :: ChannelsInfoAttributes -> Int #

ToURLParam ChannelsInfoAttributes Source #

Instance details

Defined in Network.Pusher.Protocol

Methods

toURLParam :: ChannelsInfoAttributes -> Text Source #

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.20-EO7SDYLwc3i8qsaAA7kRsy" 'False) (C1 ('MetaCons "ChannelsUserCount" 'PrefixI 'False) (U1 :: Type -> Type))

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

Instances details

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

newtype User Source #

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

Constructors

User
Fields userID :: Text

Instances

Instances details

FromJSON User Source #
Instance details Defined in Network.Pusher.Protocol Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] # omittedField :: Maybe User #
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 Methods parseJSON :: Value -> Parser Users # parseJSONList :: Value -> Parser [Users] # omittedField :: Maybe Users #
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

Instances

Instances details

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

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