Web.Telegraph.Types

Type definitions, note that all fields are strict

Documentation

data Account

A Telegraph account

Constructors

Account

Fields

• shortName :: Text

  Account name, helps users with several accounts remember which they are currently using

  Displayed to the user above the "Edit/Publish" button on Telegra.ph, other users don't see this name

• authorName :: Text

  Default author name used when creating new articles

• authorUrl :: Text

  Profile link, opened when users click on the author's name below the title

  Can be any link, not necessarily to a Telegram profile or channel

• accessToken :: Maybe Text

  Access token of the Telegraph account

• authUrl :: Maybe Text

  URL to authorize a browser on telegra.ph and connect it to a Telegraph account

  This URL is valid for only one use and for 5 minutes only

• pageCount :: Maybe Int

  Number of pages belonging to the Telegraph account

Instances

Eq Account

Defined in Web.Telegraph.Types

Methods

(==) :: Account -> Account -> Bool

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

Show Account

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> Account -> ShowS

show :: Account -> String

showList :: [Account] -> ShowS

ToJSON Account

Defined in Web.Telegraph.Types

Methods

toJSON :: Account -> Value

toEncoding :: Account -> Encoding

toJSONList :: [Account] -> Value

toEncodingList :: [Account] -> Encoding

FromJSON Account

Defined in Web.Telegraph.Types

Methods

parseJSON :: Value -> Parser Account

parseJSONList :: Value -> Parser [Account]

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "accessToken" k Account Account a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Account Account a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "authUrl" k Account Account a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Account Account a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "authorName" k Account Account a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Account Account a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "authorUrl" k Account Account a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Account Account a b

(k ~ A_Lens, a ~ Maybe Int, b ~ Maybe Int) => LabelOptic "pageCount" k Account Account a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Account Account a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "shortName" k Account Account a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Account Account a b

data PageList

A list of Telegraph articles belonging to an account

Most recently created articles first

Constructors

PageList

Fields

• totalCount :: Int

  Total number of pages belonging to the target Telegraph account

• pages :: [Page]

  Requested pages of the target Telegraph account

Instances

Eq PageList

Defined in Web.Telegraph.Types

Methods

(==) :: PageList -> PageList -> Bool

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

Show PageList

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> PageList -> ShowS

show :: PageList -> String

showList :: [PageList] -> ShowS

ToJSON PageList

Defined in Web.Telegraph.Types

Methods

toJSON :: PageList -> Value

toEncoding :: PageList -> Encoding

toJSONList :: [PageList] -> Value

toEncodingList :: [PageList] -> Encoding

FromJSON PageList

Defined in Web.Telegraph.Types

Methods

parseJSON :: Value -> Parser PageList

parseJSONList :: Value -> Parser [PageList]

(k ~ A_Lens, a ~ [Page], b ~ [Page]) => LabelOptic "pages" k PageList PageList a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx PageList PageList a b

(k ~ A_Lens, a ~ Int, b ~ Int) => LabelOptic "totalCount" k PageList PageList a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx PageList PageList a b

data Page

A page on Telegraph

Constructors

Page

Fields

• path :: Text

  Path to the page

• url :: Text

  URL of the page

• title :: Text

  Title of the page

• description :: Text

  Description of the page

• authorName :: Maybe Text

  Name of the author, displayed below the title

• authorUrl :: Maybe Text

  rofile link, opened when users click on the author's name below the title

  Can be any link, not necessarily to a Telegram profile or channel

• imageUrl :: Maybe Text

  Image URL of the page

• content :: Maybe [Node]

  Content of the page

• views :: Int

  Number of page views for the page

• canEdit :: Maybe Bool

  True, if the target Telegraph account can edit the page

Instances

Eq Page

Defined in Web.Telegraph.Types

Methods

(==) :: Page -> Page -> Bool

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

Show Page

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> Page -> ShowS

show :: Page -> String

showList :: [Page] -> ShowS

ToJSON Page

Defined in Web.Telegraph.Types

Methods

toJSON :: Page -> Value

toEncoding :: Page -> Encoding

toJSONList :: [Page] -> Value

toEncodingList :: [Page] -> Encoding

FromJSON Page

Defined in Web.Telegraph.Types

Methods

parseJSON :: Value -> Parser Page

parseJSONList :: Value -> Parser [Page]

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "authorName" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "authorUrl" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "canEdit" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

(k ~ A_Lens, a ~ Maybe [Node], b ~ Maybe [Node]) => LabelOptic "content" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "description" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "imageUrl" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "path" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "title" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "url" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

(k ~ A_Lens, a ~ Int, b ~ Int) => LabelOptic "views" k Page Page a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Page Page a b

newtype PageViews

The number of page views for a Telegraph article

Constructors

PageViews

Fields

• views :: Int

Instances

Eq PageViews

Defined in Web.Telegraph.Types

Methods

(==) :: PageViews -> PageViews -> Bool

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

Show PageViews

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> PageViews -> ShowS

show :: PageViews -> String

showList :: [PageViews] -> ShowS

ToJSON PageViews

Defined in Web.Telegraph.Types

Methods

toJSON :: PageViews -> Value

toEncoding :: PageViews -> Encoding

toJSONList :: [PageViews] -> Value

toEncodingList :: [PageViews] -> Encoding

FromJSON PageViews

Defined in Web.Telegraph.Types

Methods

parseJSON :: Value -> Parser PageViews

parseJSONList :: Value -> Parser [PageViews]

(k ~ An_Iso, a ~ Int, b ~ Int) => LabelOptic "views" k PageViews PageViews a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx PageViews PageViews a b

data Node

A DOM Node

Constructors

Content Text

Element NodeElement

Instances

Eq Node

Defined in Web.Telegraph.Types

Methods

(==) :: Node -> Node -> Bool

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

Show Node

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

ToJSON Node

Defined in Web.Telegraph.Types

Methods

toJSON :: Node -> Value

toEncoding :: Node -> Encoding

toJSONList :: [Node] -> Value

toEncodingList :: [Node] -> Encoding

FromJSON Node

Defined in Web.Telegraph.Types

Methods

parseJSON :: Value -> Parser Node

parseJSONList :: Value -> Parser [Node]

(k ~ A_Prism, a ~ Text, b ~ Text) => LabelOptic "_Content" k Node Node a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Node Node a b

(k ~ A_Prism, a ~ NodeElement, b ~ NodeElement) => LabelOptic "_Element" k Node Node a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Node Node a b

data NodeElement

A DOM elemen node

Constructors

NodeElement

Fields

• tag :: Text

  Name of the DOM element

  Available tags: a, aside, b, blockquote, br, code, em, figcaption, figure, h3, h4, hr, i, iframe, img, li, ol, p, pre, s, strong, u, ul, video

• attrs :: [(Text, [Text])]

  Attributes of the DOM element

  Key of object represents name of attribute, value represents value of attribute

  Available attributes: href, src

• children :: [Node]

  List of child nodes for the DOM element

Instances

Eq NodeElement

Defined in Web.Telegraph.Types

Methods

(==) :: NodeElement -> NodeElement -> Bool

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

Show NodeElement

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> NodeElement -> ShowS

show :: NodeElement -> String

showList :: [NodeElement] -> ShowS

Generic NodeElement

Defined in Web.Telegraph.Types

Associated Types

type Rep NodeElement :: Type -> Type

Methods

from :: NodeElement -> Rep NodeElement x

to :: Rep NodeElement x -> NodeElement

ToJSON NodeElement

Defined in Web.Telegraph.Types

Methods

toJSON :: NodeElement -> Value

toEncoding :: NodeElement -> Encoding

toJSONList :: [NodeElement] -> Value

toEncodingList :: [NodeElement] -> Encoding

FromJSON NodeElement

Defined in Web.Telegraph.Types

Methods

parseJSON :: Value -> Parser NodeElement

parseJSONList :: Value -> Parser [NodeElement]

(k ~ A_Lens, a ~ [(Text, [Text])], b ~ [(Text, [Text])]) => LabelOptic "attrs" k NodeElement NodeElement a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx NodeElement NodeElement a b

(k ~ A_Lens, a ~ [Node], b ~ [Node]) => LabelOptic "children" k NodeElement NodeElement a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx NodeElement NodeElement a b

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "tag" k NodeElement NodeElement a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx NodeElement NodeElement a b

type Rep NodeElement

Defined in Web.Telegraph.Types

type Rep NodeElement = D1 ('MetaData "NodeElement" "Web.Telegraph.Types" "telegraph-1.2.0-1GoZkpi2CtkFqjtACPJlam" 'False) (C1 ('MetaCons "NodeElement" 'PrefixI 'True) (S1 ('MetaSel ('Just "tag") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "attrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [(Text, [Text])]) :*: S1 ('MetaSel ('Just "children") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Node]))))

data Result a

The result of an API call

Constructors

Error Text

Result a

Instances

(k ~ A_Prism, a1 ~ Text, b ~ Text) => LabelOptic "_Error" k (Result a2) (Result a2) a1 b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx (Result a2) (Result a2) a1 b

(k ~ A_Prism, a1 ~ a2, b ~ a3) => LabelOptic "_Result" k (Result a2) (Result a3) a1 b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx (Result a2) (Result a3) a1 b

Eq a => Eq (Result a)

Defined in Web.Telegraph.Types

Methods

(==) :: Result a -> Result a -> Bool

(/=) :: Result a -> Result a -> Bool

Show a => Show (Result a)

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

FromJSON a => FromJSON (Result a)

Defined in Web.Telegraph.Types

Methods

parseJSON :: Value -> Parser (Result a)

parseJSONList :: Value -> Parser [Result a]

newtype Image

An image uploaded to Telegraph

Constructors

Image

Fields

• src :: Text

  The path to the image

Instances

Eq Image

Defined in Web.Telegraph.Types

Methods

(==) :: Image -> Image -> Bool

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

Show Image

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> Image -> ShowS

show :: Image -> String

showList :: [Image] -> ShowS

ToJSON Image

Defined in Web.Telegraph.Types

Methods

toJSON :: Image -> Value

toEncoding :: Image -> Encoding

toJSONList :: [Image] -> Value

toEncodingList :: [Image] -> Encoding

FromJSON Image

Defined in Web.Telegraph.Types

Methods

parseJSON :: Value -> Parser Image

parseJSONList :: Value -> Parser [Image]

(k ~ An_Iso, a ~ Text, b ~ Text) => LabelOptic "src" k Image Image a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx Image Image a b

data UploadResult

The result of an image upload

Constructors

UploadError

Fields

• error :: Text

Sources [Image]

Instances

Eq UploadResult

Defined in Web.Telegraph.Types

Methods

(==) :: UploadResult -> UploadResult -> Bool

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

Show UploadResult

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> UploadResult -> ShowS

show :: UploadResult -> String

showList :: [UploadResult] -> ShowS

ToJSON UploadResult

Defined in Web.Telegraph.Types

Methods

toJSON :: UploadResult -> Value

toEncoding :: UploadResult -> Encoding

toJSONList :: [UploadResult] -> Value

toEncodingList :: [UploadResult] -> Encoding

FromJSON UploadResult

Defined in Web.Telegraph.Types

Methods

parseJSON :: Value -> Parser UploadResult

parseJSONList :: Value -> Parser [UploadResult]

(k ~ A_Prism, a ~ [Image], b ~ [Image]) => LabelOptic "_Sources" k UploadResult UploadResult a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx UploadResult UploadResult a b

(k ~ A_Prism, a ~ Text, b ~ Text) => LabelOptic "_UploadError" k UploadResult UploadResult a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx UploadResult UploadResult a b

(k ~ An_AffineTraversal, a ~ Text, b ~ Text) => LabelOptic "error" k UploadResult UploadResult a b

Defined in Web.Telegraph.Types

Methods

labelOptic :: Optic k NoIx UploadResult UploadResult a b

newtype TelegraphError

Constructors

APICallFailure Text

An api call has failed, we cannot distinguish between minor errors (such as illformed author urls) and much serious errors, such as invalid accessTokens, so we always throw exceptions

Instances

Eq TelegraphError

Defined in Web.Telegraph.Types

Methods

(==) :: TelegraphError -> TelegraphError -> Bool

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

Show TelegraphError

Defined in Web.Telegraph.Types

Methods

showsPrec :: Int -> TelegraphError -> ShowS

show :: TelegraphError -> String

showList :: [TelegraphError] -> ShowS

Exception TelegraphError

Defined in Web.Telegraph.Types

Methods

toException :: TelegraphError -> SomeException

fromException :: SomeException -> Maybe TelegraphError

displayException :: TelegraphError -> String