Network.PinPon.API.Topic

Types

data Notification

A pinpon doorbell notification.

pinpon doorbell notifications are sent by pinpon API clients to the server. The server translates these notifications to the format(s) required by the doorbell's subscribers.

Note that some notification formats don't support sound (e.g., email and SMS). This field will be ignored on platforms that do not support it.

Constructors

Notification

Fields

• _headline :: !Text

  A summary of the notification, preferably a single line

• _message :: !Text

  A more detailed message (can be multiple lines)

• _sound :: !Text

  A client-specific string denoting the sound to play

Instances

Show Notification

Methods

showsPrec :: Int -> Notification -> ShowS

show :: Notification -> String

showList :: [Notification] -> ShowS

Generic Notification

Associated Types

type Rep Notification :: * -> *

Methods

from :: Notification -> Rep Notification x

to :: Rep Notification x -> Notification

ToJSON Notification

Methods

toJSON :: Notification -> Value

toEncoding :: Notification -> Encoding

toJSONList :: [Notification] -> Value

toEncodingList :: [Notification] -> Encoding

FromJSON Notification

Methods

parseJSON :: Value -> Parser Notification

parseJSONList :: Value -> Parser [Notification]

ToHtml Notification

Methods

toHtml :: Monad m => Notification -> HtmlT m ()

toHtmlRaw :: Monad m => Notification -> HtmlT m ()

ToSchema Notification

Methods

declareNamedSchema :: proxy Notification -> Declare (Definitions Schema) NamedSchema

type Rep Notification

type Rep Notification = D1 * (MetaData "Notification" "Network.PinPon.Notification" "pinpon-0.2.0.2-4qr5UtbLOPzcN6QnW2Swa" False) (C1 * (MetaCons "Notification" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_headline") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_message") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type TopicAPI = "topic" :> (ReqBody '[JSON] Notification :> Post '[JSON, HTML] Notification)

Servant functions

topicServer :: ServerT TopicAPI App