Safe Haskell	None
Language	Haskell2010

Line.Messaging.API.Types

Contents

Common types
Message types
Profile
Error types

Description

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

Synopsis

Common types

Re-exported for convenience.

module Line.Messaging.Common.Types

Message types

class Messageable a #

A type class representing types to be converted into Message.

It has toType and toObject as its minimal complete definition, but it is not recommended to define any extra instance, as the new type may not work with the LINE APIs.

About existing messageable types, please refer to the following instances. Each instance is matched with a message object described in the LINE documentation.

Minimal complete definition

toType, toObject

Instances

Messageable ImageMap #
Methods toType :: ImageMap -> Text toObject :: ImageMap -> [Pair] toValue :: ImageMap -> Value
Messageable Sticker #
Methods toType :: Sticker -> Text toObject :: Sticker -> [Pair] toValue :: Sticker -> Value
Messageable Location #
Methods toType :: Location -> Text toObject :: Location -> [Pair] toValue :: Location -> Value
Messageable Audio #
Methods toType :: Audio -> Text toObject :: Audio -> [Pair] toValue :: Audio -> Value
Messageable Video #
Methods toType :: Video -> Text toObject :: Video -> [Pair] toValue :: Video -> Value
Messageable Image #
Methods toType :: Image -> Text toObject :: Image -> [Pair] toValue :: Image -> Value
Messageable Text #
Methods toType :: Text -> Text toObject :: Text -> [Pair] toValue :: Text -> Value
Messageable (Template Carousel) #
Methods toType :: Template Carousel -> Text toObject :: Template Carousel -> [Pair] toValue :: Template Carousel -> Value
Messageable (Template Confirm) #
Methods toType :: Template Confirm -> Text toObject :: Template Confirm -> [Pair] toValue :: Template Confirm -> Value
Messageable (Template Buttons) #
Methods toType :: Template Buttons -> Text toObject :: Template Buttons -> [Pair] toValue :: Template Buttons -> Value

data Message #

A type representing a message to be sent.

The data constructor converts Messageable into Message. It allows different types of Messageable to be sent through a single API call.

An example usage is like below.

pushTextAndImage :: ID -> APIIO ()
pushTextAndImage identifier = push identifier [
  Message $ Text "hello",
  Message $ Image "https://example.com/image.jpg" "https://example.com/preview.jpg"
  ]

Constructors

(Show a, Messageable a) => Message a

Instances

Show Message #
Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
ToJSON Message #
Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding #

Text

newtype Text #

Messageable for text data.

It contains Text of Data.Text. Its corresponding JSON spec is described here.

This type is also used to decode text event message from webhook request. About the webhook usage, please refer to EventMessage in Line.Messaging.Webhook.Types.

Constructors

Text
Fields getText :: Text

Instances

Eq Text #
Methods (==) :: Text -> Text -> Bool # (/=) :: Text -> Text -> Bool #
Ord Text #
Methods compare :: Text -> Text -> Ordering # (<) :: Text -> Text -> Bool # (<=) :: Text -> Text -> Bool # (>) :: Text -> Text -> Bool # (>=) :: Text -> Text -> Bool # max :: Text -> Text -> Text # min :: Text -> Text -> Text #
Show Text #
Methods showsPrec :: Int -> Text -> ShowS # show :: Text -> String # showList :: [Text] -> ShowS #
FromJSON Text #
Methods parseJSON :: Value -> Parser Text # parseJSONList :: Value -> Parser [Text] #
Messageable Text #
Methods toType :: Text -> Text toObject :: Text -> [Pair] toValue :: Text -> Value

Image

data Image #

Messageable for image data.

It contains URLs of an original image and its preview. Its corresponding JSON spec is described here.

Constructors

Image
Fields getImageURL :: URL getImagePreviewURL :: URL

Instances

Eq Image #
Methods (==) :: Image -> Image -> Bool # (/=) :: Image -> Image -> Bool #
Show Image #
Methods showsPrec :: Int -> Image -> ShowS # show :: Image -> String # showList :: [Image] -> ShowS #
Messageable Image #
Methods toType :: Image -> Text toObject :: Image -> [Pair] toValue :: Image -> Value

Video

data Video #

Messageable for video data.

It contains URLs of an original video and its preview. Its corresponding JSON spec is described here.

Constructors

Video
Fields getVideoURL :: URL getVideoPreviewURL :: URL

Instances

Eq Video #
Methods (==) :: Video -> Video -> Bool # (/=) :: Video -> Video -> Bool #
Show Video #
Methods showsPrec :: Int -> Video -> ShowS # show :: Video -> String # showList :: [Video] -> ShowS #
Messageable Video #
Methods toType :: Video -> Text toObject :: Video -> [Pair] toValue :: Video -> Value

Audio

data Audio #

Messageable for audio data.

It contains a URL of an audio, and its duration in milliseconds. Its corresponding JSON spec is described here.

Constructors

Audio
Fields getAudioURL :: URL getAudioDuration :: Integer

Instances

Eq Audio #
Methods (==) :: Audio -> Audio -> Bool # (/=) :: Audio -> Audio -> Bool #
Show Audio #
Methods showsPrec :: Int -> Audio -> ShowS # show :: Audio -> String # showList :: [Audio] -> ShowS #
Messageable Audio #
Methods toType :: Audio -> Text toObject :: Audio -> [Pair] toValue :: Audio -> Value

Location

data Location #

Messageable for location data.

It contains a title, address, and geographic coordination of a location. Its corresponding JSON spec is described here.

This type is also used to decode location event message from webhook request. About the webhook usage, please refer to EventMessage in Line.Messaging.Webhook.Types.

Constructors

Location
Fields getLocationTitle :: Text getAddress :: Text getLatitude :: Double getLongitude :: Double

Instances

Eq Location #
Methods (==) :: Location -> Location -> Bool # (/=) :: Location -> Location -> Bool #
Show Location #
Methods showsPrec :: Int -> Location -> ShowS # show :: Location -> String # showList :: [Location] -> ShowS #
FromJSON Location #
Methods parseJSON :: Value -> Parser Location # parseJSONList :: Value -> Parser [Location] #
Messageable Location #
Methods toType :: Location -> Text toObject :: Location -> [Pair] toValue :: Location -> Value

Sticker

data Sticker #

Messageable for sticker data.

It contains its package and sticker ID. Its corresponding JSON spec is described here.

This type is also used to decode sticker event message from webhook request. About the webhook usage, please refer to EventMessage in Line.Messaging.Webhook.Types.

Constructors

Sticker
Fields getPackageID :: ID getStickerID :: ID

Instances

Eq Sticker #
Methods (==) :: Sticker -> Sticker -> Bool # (/=) :: Sticker -> Sticker -> Bool #
Show Sticker #
Methods showsPrec :: Int -> Sticker -> ShowS # show :: Sticker -> String # showList :: [Sticker] -> ShowS #
FromJSON Sticker #
Methods parseJSON :: Value -> Parser Sticker # parseJSONList :: Value -> Parser [Sticker] #
Messageable Sticker #
Methods toType :: Sticker -> Text toObject :: Sticker -> [Pair] toValue :: Sticker -> Value

Image map

data ImageMap #

Messageable for image map data.

About how to send an image map message and what each field means, please refer to image map message spec.

Constructors

ImageMap
Fields getBaseImageURL :: URL Base URL of images getIMAltText :: Text Alt text for devices not supporting image map getBaseImageSize :: (Integer, Integer) Image size tuple, (width, height) specifically. The width to be set to 1040, the height to be set to the value corresponding to a width of 1040. getIMActions :: [ImageMapAction] Actions to be executed when each area is tapped

Instances

Eq ImageMap #
Methods (==) :: ImageMap -> ImageMap -> Bool # (/=) :: ImageMap -> ImageMap -> Bool #
Show ImageMap #
Methods showsPrec :: Int -> ImageMap -> ShowS # show :: ImageMap -> String # showList :: [ImageMap] -> ShowS #
Messageable ImageMap #
Methods toType :: ImageMap -> Text toObject :: ImageMap -> [Pair] toValue :: ImageMap -> Value

data ImageMapAction #

A type representing actions when a specific area of an image map is tapped.

It contains action data and area information.

Constructors

IMURIAction URL ImageMapArea	Open a web page when an area is tapped.
IMMessageAction Text ImageMapArea	Send a text message from the user who tapped an area.

Instances

Eq ImageMapAction #
Methods (==) :: ImageMapAction -> ImageMapAction -> Bool # (/=) :: ImageMapAction -> ImageMapAction -> Bool #
Show ImageMapAction #
Methods showsPrec :: Int -> ImageMapAction -> ShowS # show :: ImageMapAction -> String # showList :: [ImageMapAction] -> ShowS #
ToJSON ImageMapAction #
Methods toJSON :: ImageMapAction -> Value # toEncoding :: ImageMapAction -> Encoding # toJSONList :: [ImageMapAction] -> Value # toEncodingList :: [ImageMapAction] -> Encoding #

type ImageMapArea = (Integer, Integer, Integer, Integer) #

A type representing a tappable area in an image map

Each component means (x, y, width, height) correspondingly.

Template

data Template t #

Messageable for template data.

It has a type parameter t which means a template content type. The type is polymolphic, but Messageable instances are defined only for Buttons, Confirm, and Carousel.

About how to send template message and what each field means, please refer to template message spec.

Constructors

Template
Fields getTemplateAltText :: Text Alt text for devices not supporting template message getTemplate :: t Template content type

Instances

Eq t => Eq (Template t) #
Methods (==) :: Template t -> Template t -> Bool # (/=) :: Template t -> Template t -> Bool #
Show t => Show (Template t) #
Methods showsPrec :: Int -> Template t -> ShowS # show :: Template t -> String # showList :: [Template t] -> ShowS #
Messageable (Template Carousel) #
Methods toType :: Template Carousel -> Text toObject :: Template Carousel -> [Pair] toValue :: Template Carousel -> Value
Messageable (Template Confirm) #
Methods toType :: Template Confirm -> Text toObject :: Template Confirm -> [Pair] toValue :: Template Confirm -> Value
Messageable (Template Buttons) #
Methods toType :: Template Buttons -> Text toObject :: Template Buttons -> [Pair] toValue :: Template Buttons -> Value

data Buttons #

The buttons content type for template message.

Buttons template

For more details of each field, please refer to the Buttons section in the LINE documentation.

Constructors

Buttons
Fields getButtonsThumbnailURL :: Maybe URL URL for thumbnail image getButtonsTitle :: Maybe Text Title text getButtonsText :: Text Description text getButtonsActions :: [TemplateAction] A list of template actions, each of which represents a button (max: 4)

Instances

Eq Buttons #
Methods (==) :: Buttons -> Buttons -> Bool # (/=) :: Buttons -> Buttons -> Bool #
Show Buttons #
Methods showsPrec :: Int -> Buttons -> ShowS # show :: Buttons -> String # showList :: [Buttons] -> ShowS #
ToJSON Buttons #
Methods toJSON :: Buttons -> Value # toEncoding :: Buttons -> Encoding # toJSONList :: [Buttons] -> Value # toEncodingList :: [Buttons] -> Encoding #
Messageable (Template Buttons) #
Methods toType :: Template Buttons -> Text toObject :: Template Buttons -> [Pair] toValue :: Template Buttons -> Value

data Confirm #

The confirm content type for template message.

Confirm template

For more details of each field, please refer to the Confirm section in the LINE documentation.

Constructors

Confirm
Fields getConfirmText :: Text Confirm text getConfirmActions :: [TemplateAction] A list of template actions, each of which represents a button (max: 2)

Instances

Eq Confirm #
Methods (==) :: Confirm -> Confirm -> Bool # (/=) :: Confirm -> Confirm -> Bool #
Show Confirm #
Methods showsPrec :: Int -> Confirm -> ShowS # show :: Confirm -> String # showList :: [Confirm] -> ShowS #
ToJSON Confirm #
Methods toJSON :: Confirm -> Value # toEncoding :: Confirm -> Encoding # toJSONList :: [Confirm] -> Value # toEncodingList :: [Confirm] -> Encoding #
Messageable (Template Confirm) #
Methods toType :: Template Confirm -> Text toObject :: Template Confirm -> [Pair] toValue :: Template Confirm -> Value

data Carousel #

The carousel content type for template message.

Carousel template

For more details of each field, please refer to the Carousel section in the LINE documentation.

Constructors

Carousel
Fields getColumns :: [Column] A list of columns for a carousel template

Instances

Eq Carousel #
Methods (==) :: Carousel -> Carousel -> Bool # (/=) :: Carousel -> Carousel -> Bool #
Show Carousel #
Methods showsPrec :: Int -> Carousel -> ShowS # show :: Carousel -> String # showList :: [Carousel] -> ShowS #
ToJSON Carousel #
Methods toJSON :: Carousel -> Value # toEncoding :: Carousel -> Encoding # toJSONList :: [Carousel] -> Value # toEncodingList :: [Carousel] -> Encoding #
Messageable (Template Carousel) #
Methods toType :: Template Carousel -> Text toObject :: Template Carousel -> [Pair] toValue :: Template Carousel -> Value

data Column #

Actual contents of carousel template.

It has the same fields as Buttons, except that the number of actions is up to 3.

Constructors

Column
Fields getColumnThumbnailURL :: Maybe URL URL for thumbnail image getColumnTitle :: Maybe Text Title text getColumnText :: Text Description text getColumnActions :: [TemplateAction] A list of template actions, each of which represents a button (max: 3)

Instances

Eq Column #
Methods (==) :: Column -> Column -> Bool # (/=) :: Column -> Column -> Bool #
Show Column #
Methods showsPrec :: Int -> Column -> ShowS # show :: Column -> String # showList :: [Column] -> ShowS #
ToJSON Column #
Methods toJSON :: Column -> Value # toEncoding :: Column -> Encoding # toJSONList :: [Column] -> Value # toEncodingList :: [Column] -> Encoding #

type Label = Text #

Just a type alias for Text, used with TemplateAction.

data TemplateAction #

A data type for possible template actions.

Each action object represents a button in template message. A button has a label and an actual action fired by click.

Constructors

TplMessageAction Label Text	Message action. When clicked, a specified text will be sent into the same room by a user who clicked the button.
TplPostbackAction Label Postback (Maybe Text)	Postback action. When clicked, a specified text will be sent, and postback data will be sent to webhook server as a postback event.
TplURIAction Label URL	URI action. When clicked, a web page with a specified URI will open in the in-app browser.

Instances

Eq TemplateAction #
Methods (==) :: TemplateAction -> TemplateAction -> Bool # (/=) :: TemplateAction -> TemplateAction -> Bool #
Show TemplateAction #
Methods showsPrec :: Int -> TemplateAction -> ShowS # show :: TemplateAction -> String # showList :: [TemplateAction] -> ShowS #
ToJSON TemplateAction #
Methods toJSON :: TemplateAction -> Value # toEncoding :: TemplateAction -> Encoding # toJSONList :: [TemplateAction] -> Value # toEncodingList :: [TemplateAction] -> Encoding #

Profile

data Profile #

A type to represent a user's profile.

It is the return type of the getProfile API in the Line.Messaging.API module.

Constructors

Profile
Fields getUserID :: ID getDisplayName :: Text getPictureURL :: Maybe URL getStatusMessage :: Maybe Text

Instances

Eq Profile #
Methods (==) :: Profile -> Profile -> Bool # (/=) :: Profile -> Profile -> Bool #
Show Profile #
Methods showsPrec :: Int -> Profile -> ShowS # show :: Profile -> String # showList :: [Profile] -> ShowS #
FromJSON Profile #
Methods parseJSON :: Value -> Parser Profile # parseJSONList :: Value -> Parser [Profile] #

Error types

data APIError #

An error type possibly returned from the APIIO type.

State code errors may contain a parsed error body. Other types of errors, which may rarely occur if used properly, does not.

For more details of error types, please refer to Status codes and Error response sections in the LINE documentation.

Constructors

BadRequest (Maybe APIErrorBody)	400 Bad Request with a parsed error body, caused by badly formatted request.
Unauthorized (Maybe APIErrorBody)	401 Unauthorized with a parsed error body, caused by invalid access token.
Forbidden (Maybe APIErrorBody)	403 Forbidden with a parsed error body, caused by unauthorized account or plan.
TooManyRequests (Maybe APIErrorBody)	429 Too Many Requests with a parsed error body, caused by exceeding the rate limit.
InternalServerError (Maybe APIErrorBody)	500 Internal Server Error with a parsed error body.
UndefinedStatusCode Int ByteString	Caused by status codes other than 200 and listed statuses above, with the status code and request body.
JSONDecodeError String	Caused by badly formatted response body from APIs.
UndefinedError SomeException	Any other exception caught as `SomeException`.

Instances

Show APIError #
Methods showsPrec :: Int -> APIError -> ShowS # show :: APIError -> String # showList :: [APIError] -> ShowS #

data APIErrorBody #

An error body type.

It contains error message, and may contain property information and detailed error bodies.

Constructors

APIErrorBody
Fields getErrorMessage :: Text getErrorProperty :: Maybe Text getErrorDetails :: Maybe [APIErrorBody]

Instances

Eq APIErrorBody #
Methods (==) :: APIErrorBody -> APIErrorBody -> Bool # (/=) :: APIErrorBody -> APIErrorBody -> Bool #
Show APIErrorBody #
Methods showsPrec :: Int -> APIErrorBody -> ShowS # show :: APIErrorBody -> String # showList :: [APIErrorBody] -> ShowS #
FromJSON APIErrorBody #
Methods parseJSON :: Value -> Parser APIErrorBody # parseJSONList :: Value -> Parser [APIErrorBody] #