Chat.Flowdock

Contents

• Using the client
  • Authentication types
  • General types
  • REST API
  • Pushing messages to the inbox
  • Pushing messages to the chatroom
  • Streaming events
  • Constructing messages
    • InboxPushMessage fields
    • ChatPushMessage fields
    • Common fields
    • Exception types
    • Lens field classes

Description

Synopsis

• data FlowdockClient a
• withFlowdockClient :: ClientManagerSettings auth => auth -> (FlowdockClient auth -> IO a) -> IO a
• newtype Push = Push {
  • pushFlowApiToken :: Text
  }
• newtype User = User {
  • userAccessToken :: Text
  }
• data Flow
  • = QualifiedFlow {
    • flowOrganization :: Text
    • flowFlow :: Text
    }
  • | FlowId Text
• class MessageType a
• data Message a
• newtype MessageId = MessageId Int
• message :: Flow -> a -> Message a
• comment :: Text -> MessageId -> Comment
• data Chat
• data FileUpload
• data Status
• sendMessage :: MessageType a => FlowdockClient User -> Message a -> IO (MessageResponse a)
• data Comment
• sendComment :: FlowdockClient User -> Message Comment -> IO (MessageResponse Comment)
• pushToInbox :: FlowdockClient Push -> InboxPushMessage -> IO ()
• newInboxPushMessage :: InboxPushMessage
• data MessageResponse c
• pushToChat :: FlowdockClient Push -> ChatPushMessage -> IO ()
• type Content = Text
• type ExternalUserName = Text
• newChatPushMessage :: ExternalUserName -> Content -> ChatPushMessage
• data FlowFilter
• allFlows :: FlowFilter
• justFlows :: [Flow] -> FlowFilter
• data StreamQuery a
• type Event = Object
• streamOptions :: a -> StreamQuery a
• streamFlow :: FlowdockClient User -> StreamQuery Flow -> (Producer Event IO () -> IO a) -> IO a
• streamFlows :: FlowdockClient User -> StreamQuery FlowFilter -> (Producer Event IO () -> IO a) -> IO a
• data InboxPushMessage
• data InboxPushFormat = Html
• data ChatPushMessage
• data Tag
  • = UserTag Text
  • | HashTag Text
• data JSONError = JSONError String
• class HasActive s a | s -> a where
  • active :: Lens' s a
• class HasApp s a | s -> a where
  • app :: Lens' s a
• class HasContent s a | s -> a where
  • content :: Lens' s a
• class HasContentType s a | s -> a where
  • contentType :: Lens' s a
• class HasEvent s a | s -> a where
  • event :: Lens' s a
• class HasExternalUserName s a | s -> a where
  • externalUserName :: Lens' s a
• class HasFileName s a | s -> a where
  • fileName :: Lens' s a
• class HasFlow s a | s -> a where
  • flow :: Traversal' s a
• class HasFormat s a | s -> a where
  • format :: Lens' s a
• class HasFromAddress s a | s -> a where
  • fromAddress :: Lens' s a
• class HasFromName s a | s -> a where
  • fromName :: Lens' s a
• class HasLink s a | s -> a where
  • link :: Lens' s a
• class HasMessageId s a | s -> a where
  • messageId :: Lens' s a
• class HasOrganization s a | s -> a where
  • organization :: Traversal' s a
• class HasProject s a | s -> a where
  • project :: Lens' s a
• class HasReplyTo s a | s -> a where
  • replyTo :: Lens' s a
• class HasSent s a | s -> a where
  • sent :: Lens' s a
• class HasSource s a | s -> a where
  • source :: Lens' s a
• class HasSubject s a | s -> a where
  • subject :: Lens' s a
• class HasTags s a | s -> a where
  • tags :: Lens' s a
• class HasUser s a | s -> a where
  • user :: Lens' s a
• class HasUuid s a | s -> a where
  • uuid :: Lens' s a

Using the client

{-# LANGUAGE OverloadedStrings #-}

import Chat.Flowdock

-- The push API uses the 'Push' authentication type
main = withFlowdockClient (Push "YOUR_FLOW_TOKEN_HERE") $ \client -> do
  let msg = newChatPushMessage "Hello World Bot" "Hello, world!"
  pushToChat client msg

Authentication types

General types

REST API

Pushing messages to the inbox

Pushing messages to the chatroom

Streaming events

Constructing messages

InboxPushMessage fields

ChatPushMessage fields

Common fields

Exception types

Lens field classes