Network.Pusher.WebSockets.Channel

Functions for subscribing to and querying channels.

Documentation

data Channel

Channel handle: a witness that we joined a channel, and is used to subscribe to events.

If this is used when unsubscribed from a channel, nothing will happen.

Instances

Eq Channel

Methods

(==) :: Channel -> Channel -> Bool

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

Ord Channel

Methods

compare :: Channel -> Channel -> Ordering

(<) :: Channel -> Channel -> Bool

(<=) :: Channel -> Channel -> Bool

(>) :: Channel -> Channel -> Bool

(>=) :: Channel -> Channel -> Bool

max :: Channel -> Channel -> Channel

min :: Channel -> Channel -> Channel

Show Channel

Methods

showsPrec :: Int -> Channel -> ShowS

show :: Channel -> String

showList :: [Channel] -> ShowS

Hashable Channel

Methods

hashWithSalt :: Int -> Channel -> Int

hash :: Channel -> Int

NFData Channel

Methods

rnf :: Channel -> ()

subscribe :: Text -> PusherClient (Maybe Channel)

Subscribe to a channel. If the channel name begins with "private-" or "presence-", authorisation is performed automatically.

This returns immediately. You should wait for the "pusher:subscription_succeeded" event before attempting to use presence channel functions like members and whoami.

If authorisation fails, this returns Nothing.

unsubscribe :: Channel -> PusherClient ()

Unsubscribe from a channel.

members :: Channel -> PusherClient (HashMap Text Value)

Return the list of all members in a presence channel.

If we have unsubscribed from this channel, or it is not a presence channel, returns an empty map.

whoami :: Channel -> PusherClient Value

Return information about the local user in a presence channel.

If we have unsubscribed from this channel, or it is not a presence channel, returns Null.