wimp - v1.1.0

wimp

A Gleam client for the Pushover push notification API.

https://pushover.net/api

Types

Builder

</>

The unix timestamp when the app counter will reset.

pub opaque type Builder

Error

</> 
pub type Error {
  MessageLimitExceeded(limits: Limits)
  InvalidApplicationToken
  BadRequest(body: String)
  RateLimited(limits: Limits, body: String)
  UnexpectedResponse(status: Int, body: String)
}

Constructors 

  • MessageLimitExceeded(limits: Limits)
  • InvalidApplicationToken
  • BadRequest(body: String)
  • RateLimited(limits: Limits, body: String)
  • UnexpectedResponse(status: Int, body: String)

Formatting

</> 
pub type Formatting {
  Html
  Text
  Monospace
}

Constructors 

  • Html
  • Text
  • Monospace

Limits

</> 
pub type Limits {
  Limits(app_limit: Int, app_remaining: Int, app_reset: Int)
}

Constructors 

  • Limits(app_limit: Int, app_remaining: Int, app_reset: Int)

    Arguments

    • app_reset

      The unix timestamp when the app counter will reset.

Priority

</> 
pub type Priority {
  Emergency(retry: Int, expire: Int)
  High
  Normal
  Low
  Lowest
}

Constructors 

  • Emergency(retry: Int, expire: Int)
  • High
  • Normal
  • Low
  • Lowest

Functions

decode_message_response

</> 
pub fn decode_message_response(
  resp: Response(String),
) -> Result(Limits, Error)

Decode the response from Pushover to determine whether the message sending was successful or not.

device

</> 
pub fn device(builder: Builder, device: String) -> Builder

Set the device to send the message to.

formatting

</> 
pub fn formatting(
  builder: Builder,
  formatting: Formatting,
) -> Builder

Set the formatting of the message.

message_request

</> 
pub fn message_request(builder: Builder) -> Request(String)

new

</> 
pub fn new(
  token token: String,
  user user: String,
  message message: String,
) -> Builder

Create a new Pushover message to send to a Pushover user as the application for the token.

Messages are limited to 1024 characters in length, longer messages will be truncated.

priority

</> 
pub fn priority(builder: Builder, priority: Priority) -> Builder

Set the priority of the message.

sound

</> 
pub fn sound(builder: Builder, sound: String) -> Builder

Set the sound of the message.

The default sounds are:

  • pushover - Pushover (default)
  • bike - Bike
  • bugle - Bugle
  • cashregister - Cash Register
  • classical - Classical
  • cosmic - Cosmic
  • falling - Falling
  • gamelan - Gamelan
  • incoming - Incoming
  • intermission - Intermission
  • magic - Magic
  • mechanical - Mechanical
  • pianobar - Piano Bar
  • siren - Siren
  • spacealarm - Space Alarm
  • tugboat - Tug Boat
  • alien - Alien Alarm (long)
  • climb - Climb (long)
  • persistent - Persistent (long)
  • echo - Pushover Echo (long)
  • updown - Up Down (long)
  • vibrate - Vibrate Only
  • none - None (silent)

supplimentary_url

</> 
pub fn supplimentary_url(
  builder: Builder,
  title title: String,
  url url: String,
) -> Builder

Set a supplimentary URL and a title for the link.

time_to_live

</> 
pub fn time_to_live(
  builder: Builder,
  seconds time_to_live: Int,
) -> Builder

Set the time to live of the message in seconds.

title

</> 
pub fn title(builder: Builder, title: String) -> Builder

Set the title of the message.

Titles are limited to 250 characters in length, longer titles will be truncated.

✨ Search Document