| Portability | unportable |
|---|---|
| Stability | unstable |
| Maintainer | Pedro Tacla Yamada <tacla.yamada@gmail.com> |
| Safe Haskell | None |
Web.HZulip
Description
A Wrapper library for the Zulip API. Works on top of a ReaderT monad
transformer, holding a ZulipOptions object, which should hold the
state and configuration for the API client.
Using the library is made easier through a set of helper functions. This
design is more concise and than passing around configuration variables;
one could easily bypass it with the use of runZulip, though that isn't
recommended.
Examples are available at the github repository for this project at: https:github.comyamadapchzulip
- data Event = Event {}
- data Message = Message {
- messageId :: Int
- messageType :: String
- messageContent :: String
- messageAvatarUrl :: String
- messageTimestamp :: Int
- messageDisplayRecipient :: Either String [User]
- messageSender :: User
- messageGravatarHash :: String
- messageRecipientId :: Int
- messageClient :: String
- messageSubjectLinks :: [String]
- messageSubject :: String
- data Queue = Queue {
- queueId :: String
- lastEventId :: Int
- data User = User {
- userId :: Int
- userFullName :: String
- userEmail :: String
- userDomain :: String
- userShortName :: String
- data ZulipOptions = ZulipOptions {
- clientEmail :: String
- clientApiKey :: String
- clientBaseUrl :: String
- clientManager :: Manager
- type ZulipM = ReaderT ZulipOptions IO
- type EventCallback = Event -> ZulipM ()
- type MessageCallback = Message -> ZulipM ()
- addSubscriptions :: [String] -> ZulipM ()
- addAllSubscriptions :: ZulipM [String]
- defaultBaseUrl :: String
- eventTypes :: [String]
- getEvents :: Queue -> Bool -> ZulipM (Queue, [Event])
- getStreams :: ZulipM [String]
- getStreamSubscribers :: String -> ZulipM [String]
- getSubscriptions :: ZulipM [String]
- onNewEvent :: [String] -> EventCallback -> ZulipM ()
- onNewMessage :: MessageCallback -> ZulipM ()
- registerQueue :: [String] -> Bool -> ZulipM Queue
- removeSubscriptions :: [String] -> ZulipM ()
- runZulip :: ZulipM a -> ZulipOptions -> IO a
- sendMessage :: String -> [String] -> String -> String -> ZulipM Int
- sendPrivateMessage :: [String] -> String -> ZulipM Int
- sendStreamMessage :: String -> String -> String -> ZulipM Int
- sinkZulipMessages :: Sink (String, [String], String, String) ZulipM ()
- sourceZulipEvents :: Int -> [String] -> Source ZulipM Event
- sourceZulipMessages :: Int -> Source ZulipM Message
- withZulip :: ZulipOptions -> ZulipM a -> IO a
- withZulipCreds :: String -> String -> ZulipM a -> IO a
- zulipOptions :: String -> String -> IO ZulipOptions
- lift :: MonadTrans t => forall m a. Monad m => m a -> t m a
- ask :: Monad m => ReaderT r m r
Documentation
data Event
Represents zulip events
data Message
Represents a Zulip Message
Constructors
| Message | |
Fields
| |
data User
Represents a zulip user account - for both display_recipient and
message_sender representations
Constructors
| User | |
Fields
| |
data ZulipOptions
Represents a Zulip API client
Constructors
| ZulipOptions | |
Fields
| |
Instances
type ZulipM = ReaderT ZulipOptions IO
The Monad in which Zulip API actions happen in. This is a ReaderT
alias, so it's also a instance of MonadTrans, MonadIO etc.
type EventCallback = Event -> ZulipM ()
The root type for Event callbacks
type MessageCallback = Message -> ZulipM ()
Type for message callbacks
addSubscriptions :: [String] -> ZulipM ()
Add new Stream subscriptions to the client.
addAllSubscriptions :: ZulipM [String]
Subscribes the client to all available streams and returns all the stream names
The default zulip API URL
eventTypes :: [String]
The list of all avaiable event types
getStreams :: ZulipM [String]
Get a list of all the public streams
getStreamSubscribers :: String -> ZulipM [String]
Get all the user emails subscribed to a stream
getSubscriptions :: ZulipM [String]
Get a list of the streams the client is currently subscribed to.
onNewEvent :: [String] -> EventCallback -> ZulipM ()
Registers an event callback for specified events and keeps executing it over events as they come in
onNewMessage :: MessageCallback -> ZulipM ()
Registers a callback to be executed whenever a message comes in. Will loop forever
registerQueue :: [String] -> Bool -> ZulipM Queue
This registers a new event queue with the zulip API. It's a lower level
function, which shouldn't be used unless you know what you're doing. It
takes a list of names of the events you want to listen for and whether
you'd like for the content to be rendered in HTML format
(if you set the last parameter to False it will be kept as typed, in
markdown format)
removeSubscriptions :: [String] -> ZulipM ()
Remove one or more Stream subscriptions from the client
runZulip :: ZulipM a -> ZulipOptions -> IO a
Helper to run Actions in the Zulip Monad
sendMessage :: String -> [String] -> String -> String -> ZulipM Int
This wraps `POST https:api.zulip.comv1messages` with a nicer root API. Simpler helpers for each specific case of this somewhat overloaded endpoint will also be provided in the future.
It takes the message mtype, mrecipients, msubject and mcontent
and returns the created message's id in the ZulipM monad.
sendPrivateMessage :: [String] -> String -> ZulipM Int
Helper for sending private messages. Takes the list of recipients and the message's content.
sendStreamMessage :: String -> String -> String -> ZulipM Int
Helper for sending stream messages. Takes the stream name, the subject and the message.
sinkZulipMessages :: Sink (String, [String], String, String) ZulipM ()
A sink representation of the zulip messaging API, takes a tuple with the
arguments for sendMessage and sends it
Arguments
| :: Int | The size of the event buffer |
| -> [String] | A list of event types to subscribe to |
| -> Source ZulipM Event |
Creates a conduit Source of zulip events
Creates a conduit Source of zulip messages
withZulip :: ZulipOptions -> ZulipM a -> IO a
Flipped version of runZulip
withZulipCreds :: String -> String -> ZulipM a -> IO a
Helper for creating a minimal ZulipOptions object and running an action
in the ZulipM monad
zulipOptions :: String -> String -> IO ZulipOptions
Helper for creating a ZulipOptions object with the baseUrl set to
defaultBaseUrl