Network.Pusher.Protocol

Types representing the JSON format of Pusher messages.

There are also types for query string parameters.

Documentation

data ChannelInfo

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

Constructors

ChannelInfo

Fields

• channelInfoUserCount :: Maybe Int

Instances

Eq ChannelInfo

Methods

(==) :: ChannelInfo -> ChannelInfo -> Bool

(/=) :: ChannelInfo -> ChannelInfo -> Bool

Show ChannelInfo

Methods

showsPrec :: Int -> ChannelInfo -> ShowS

show :: ChannelInfo -> String

showList :: [ChannelInfo] -> ShowS

FromJSON ChannelInfo

Methods

parseJSON :: Value -> Parser ChannelInfo

data ChannelInfoAttributes

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

Constructors

ChannelUserCount

ChannelSubscriptionCount

Instances

Eq ChannelInfoAttributes

Methods

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

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

Generic ChannelInfoAttributes

Associated Types

type Rep ChannelInfoAttributes :: * -> *

Methods

from :: ChannelInfoAttributes -> Rep ChannelInfoAttributes x

to :: Rep ChannelInfoAttributes x -> ChannelInfoAttributes

Hashable ChannelInfoAttributes

Methods

hashWithSalt :: Int -> ChannelInfoAttributes -> Int

hash :: ChannelInfoAttributes -> Int

ToURLParam ChannelInfoAttributes

Methods

toURLParam :: ChannelInfoAttributes -> Text

type Rep ChannelInfoAttributes

type Rep ChannelInfoAttributes = D1 (MetaData "ChannelInfoAttributes" "Network.Pusher.Protocol" "pusher-http-haskell-1.1.0.1-5o4FxunsWfpdyOxWLMq7O" False) ((:+:) (C1 (MetaCons "ChannelUserCount" PrefixI False) U1) (C1 (MetaCons "ChannelSubscriptionCount" PrefixI False) U1))

newtype ChannelInfoQuery

A set of requested ChannelInfoAttributes.

Constructors

ChannelInfoQuery (HashSet ChannelInfoAttributes)

Instances

ToURLParam ChannelInfoQuery

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

Methods

(==) :: ChannelsInfo -> ChannelsInfo -> Bool

(/=) :: ChannelsInfo -> ChannelsInfo -> Bool

Show ChannelsInfo

Methods

showsPrec :: Int -> ChannelsInfo -> ShowS

show :: ChannelsInfo -> String

showList :: [ChannelsInfo] -> ShowS

FromJSON ChannelsInfo

Methods

parseJSON :: Value -> Parser ChannelsInfo

newtype ChannelsInfoQuery

A set of requested ChannelsInfoAttributes.

Constructors

ChannelsInfoQuery (HashSet ChannelsInfoAttributes)

Instances

ToURLParam ChannelsInfoQuery

Methods

toURLParam :: ChannelsInfoQuery -> Text

data ChannelsInfoAttributes

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

Constructors

ChannelsUserCount

Instances

Eq ChannelsInfoAttributes

Methods

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

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

Generic ChannelsInfoAttributes

Associated Types

type Rep ChannelsInfoAttributes :: * -> *

Methods

from :: ChannelsInfoAttributes -> Rep ChannelsInfoAttributes x

to :: Rep ChannelsInfoAttributes x -> ChannelsInfoAttributes

Hashable ChannelsInfoAttributes

Methods

hashWithSalt :: Int -> ChannelsInfoAttributes -> Int

hash :: ChannelsInfoAttributes -> Int

ToURLParam ChannelsInfoAttributes

Methods

toURLParam :: ChannelsInfoAttributes -> Text

type Rep ChannelsInfoAttributes

type Rep ChannelsInfoAttributes = D1 (MetaData "ChannelsInfoAttributes" "Network.Pusher.Protocol" "pusher-http-haskell-1.1.0.1-5o4FxunsWfpdyOxWLMq7O" False) (C1 (MetaCons "ChannelsUserCount" PrefixI False) U1)

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

Methods

(==) :: FullChannelInfo -> FullChannelInfo -> Bool

(/=) :: FullChannelInfo -> FullChannelInfo -> Bool

Show FullChannelInfo

Methods

showsPrec :: Int -> FullChannelInfo -> ShowS

show :: FullChannelInfo -> String

showList :: [FullChannelInfo] -> ShowS

FromJSON FullChannelInfo

Methods

parseJSON :: Value -> Parser FullChannelInfo

data User

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

Constructors

User

Fields

• userID :: Text

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

Methods

parseJSON :: Value -> Parser User

newtype Users

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

Constructors

Users [User]

Instances

Eq Users

Methods

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

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

Show Users

Methods

showsPrec :: Int -> Users -> ShowS

show :: Users -> String

showList :: [Users] -> ShowS

FromJSON Users

Methods

parseJSON :: Value -> Parser Users

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.

Instances

ToURLParam ChannelInfoQuery

Methods

toURLParam :: ChannelInfoQuery -> Text

ToURLParam ChannelInfoAttributes

Methods

toURLParam :: ChannelInfoAttributes -> Text

ToURLParam ChannelsInfoQuery

Methods

toURLParam :: ChannelsInfoQuery -> Text

ToURLParam ChannelsInfoAttributes

Methods

toURLParam :: ChannelsInfoAttributes -> Text

ToURLParam a => ToURLParam (HashSet a)

Methods

toURLParam :: HashSet a -> Text

toURLParam :: ToURLParam a => a -> Text

Convert the data into a querystring parameter value.