Line.Messaging.Webhook.Types

This module provides types to be used with Line.Messaging.Webhook.

Common types

Re-exported for convenience.

module Line.Messaging.Common.Types

Validation

type Signature = ByteString

A type alias for auth signature.

It is set as X-Line-Signature header in webhook requests

Result and failure

data WebhookFailure

A failure type returned when a webhook request is malformed.

Constructors

SignatureVerificationFailed

When the signature is not valid.

MessageDecodeFailed

When the request body cannot be decoded into defined event types.

Instances

Eq WebhookFailure

Methods

(==) :: WebhookFailure -> WebhookFailure -> Bool

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

Show WebhookFailure

Methods

showsPrec :: Int -> WebhookFailure -> ShowS

show :: WebhookFailure -> String

showList :: [WebhookFailure] -> ShowS

Webhook request body

The following types and functions are about decoding a webhook request body.

Body

newtype Body

This type represents a whole request body.

It is mainly for JSON parsing, and users may not need to use this type directly.

Constructors

Body [Event]

Instances

Eq Body

Methods

(==) :: Body -> Body -> Bool

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

Show Body

Methods

showsPrec :: Int -> Body -> ShowS

show :: Body -> String

showList :: [Body] -> ShowS

FromJSON Body

Methods

parseJSON :: Value -> Parser Body

parseJSONList :: Value -> Parser [Body]

Event

Webhook event data types and instances for proper type classes (e.g. FromJSON) are implemented here.

For the event spec, please refer to the LINE documentation.

data Event

A type to represent each webhook event. The type of an event can be determined with pattern matching.

handleEvent :: Event -> IO ()
handleEvent (MessageEvent event) = handleMessageEvent event
handleEvent (BeaconEvent event) = handleBeaconEvent event
handleEvent _ = return ()

handleMessageEvent :: ReplyableEvent EventMessage -> IO ()
handleMessageEvent = undefined

handleBeaconEvent :: ReplyableEvent BeaconData -> IO ()
handleBeaconEvent = undefined

All the data contstructors have a type EventTuple r a -> Event.

Constructors

MessageEvent (ReplyableEvent EventMessage)

FollowEvent (ReplyableEvent ())

UnfollowEvent (NonReplyableEvent ())

JoinEvent (ReplyableEvent ())

LeaveEvent (NonReplyableEvent ())

PostbackEvent (ReplyableEvent Postback)

BeaconEvent (ReplyableEvent BeaconData)

Instances

Eq Event

Methods

(==) :: Event -> Event -> Bool

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

Show Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

FromJSON Event

Methods

parseJSON :: Value -> Parser Event

parseJSONList :: Value -> Parser [Event]

type EventTuple r a = (EventSource, UTCTime, r, a)

The base type for an event. It is a type alias for 4-tuple containing event data.

The type variable r is for a reply token, which is () in the case of non-replyable events. The type variable a is a content type, which is () for events without content.

type ReplyToken = Text

A type alias for reply token. It is also consumed by the reply API.

type ReplyableEvent a = EventTuple ReplyToken a

A type alias to represent a replyable event.

type NonReplyableEvent a = EventTuple () a

A type alias to represent a non-replyable event.

getSource :: EventTuple r a -> EventSource

Retrieve event source from an event.

getDatetime :: EventTuple r a -> UTCTime

Retrieve datetime when event is sent.

getReplyToken :: ReplyableEvent a -> ReplyToken

Retrieve a reply token of an event. It can be used only for ReplyableEvent.

getMessage :: ReplyableEvent EventMessage -> EventMessage

Retrieve event message from an event. It can be used only for events whose content is a message.

handleMessageEvent :: ReplyableEvent EventMessage -> IO ()
handleMessageEvent event = do
  let message = getMessage event
  print message

getPostback :: ReplyableEvent Postback -> Postback

Retrieve postback data from an event. It can be used only for events whose content is postback data.

import qualified Data.Text.IO as TIO

handlePostbackEvent :: ReplyableEvent Postback -> IO ()
handlePostbackEvent event = do
  let postback = getPostback event
  TIO.putStrLn postback

getBeacon :: ReplyableEvent BeaconData -> BeaconData

Retrieve beacon data from an event. It can be used only for events whose content is beacon data.

handleBeaconEvent :: ReplyableEvent BeaconData -> IO ()
handleBeaconEvent event = do
  let beaconData = getBeacon event
  print beaconData

Event source

data EventSource

A source from which an event is sent. It can be retrieved from events with getSource.

Constructors

User ID

Group ID

Room ID

Instances

Eq EventSource

Methods

(==) :: EventSource -> EventSource -> Bool

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

Show EventSource

Methods

showsPrec :: Int -> EventSource -> ShowS

show :: EventSource -> String

showList :: [EventSource] -> ShowS

FromJSON EventSource

Methods

parseJSON :: Value -> Parser EventSource

parseJSONList :: Value -> Parser [EventSource]

getID :: EventSource -> ID

Retrieve identifier from event source

Message event

data EventMessage

Represent message types sent with MessageEvent. It can be retrieved from message events with getMessage.

There is no actual content body sent with image, video and audio messages. It should be manually downloaded via the getContent API.

For more details of event messages, please refer to the Message event section of the LINE documentation.

Constructors

TextEM ID Text

Text event message.

ImageEM ID

Image event message.

VideoEM ID

Video event message.

AudioEM ID

Audio event message.

FileEM ID Text Integer

File event message.

LocationEM ID Location

Location event message.

StickerEM ID Sticker

Sticker event message.

Instances

Eq EventMessage

Methods

(==) :: EventMessage -> EventMessage -> Bool

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

Show EventMessage

Methods

showsPrec :: Int -> EventMessage -> ShowS

show :: EventMessage -> String

showList :: [EventMessage] -> ShowS

FromJSON EventMessage

Methods

parseJSON :: Value -> Parser EventMessage

parseJSONList :: Value -> Parser [EventMessage]

Beacon event

data BeaconData

Represent beacon data.

Constructors

BeaconEnter ID (Maybe Text)

BeaconLeave ID (Maybe Text)

BeaconBanner ID (Maybe Text)

Instances

Eq BeaconData

Methods

(==) :: BeaconData -> BeaconData -> Bool

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

Show BeaconData

Methods

showsPrec :: Int -> BeaconData -> ShowS

show :: BeaconData -> String

showList :: [BeaconData] -> ShowS

FromJSON BeaconData

Methods

parseJSON :: Value -> Parser BeaconData

parseJSONList :: Value -> Parser [BeaconData]

getHWID :: BeaconData -> ID

Get hardware ID of the beacon.

getDeviceMessage :: BeaconData -> Maybe Text

Get device message from the beacon, if exists.