Commit 28203cea authored by Samuel W. Flint's avatar Samuel W. Flint

Added a bunch of commentary

parent e1282967
;;; pushover.el --- Pushover API Access
;; Copyright (C) 2016 Samuel Flint
;; Author: Samuel W. Flint <swflint@flintfam.org>
;; Version: 1.0
;; Package-Requires: ((cl-lib "0.5"))
;; Keywords: notifications
;; URL: http://github.com/swflint/pushover.el
;;; Commentary:
;;
;; This library provides a single function, pushover-send, which is
;; used to send notifications using the pushover service.
;;; Code:
(defconst *pushover-api-key* "agd6sapvp5xcdmbuo1qdpc7mddscri")
(defvar *pushover-user-key* nil)
(cl-defun pushover-send (title message &optional (html nil) (priority 0))
(cl-defun pushover-send (title message &key url url-title sound (html t) (priority 0) retry expire)
"TITLE MESSAGE &KEY URL URL-TITLE SOUND HTML PRIORITY RETRY EXPIRE
TITLE is the message title.
MESSAGE is the message itself.
URL is a URL to be shown.
URL-TITLE is the title of the given URL.
SOUND is the sound to be used.
HTML, default t, signals to Pushover that the message is in HTML.
PRIORITY is an integer from -2 to 2, with 0 (mid-priority) being the default.
RETRY is the number of seconds between retries for emergency (2) priority.
EXPIRE is number of seconds before an emergency priority message expires."
(let ((url-request-method "POST")
(url-request-data (concat (format "token=%s&user=%s&title=%s&message=%s&priority=%s&timestamp=%s"
*pushover-api-key*
......@@ -14,7 +41,24 @@
(current-time))
(if html
"&html=1"
"")
(if url
(format "&url=%s" (url-encode-url url))
"")
(if url-title
(format "&url_title=%s" (url-encode-url url-title))
"")
(if sound
(format "&sound=%s" sound)
"")
(if retry
(format "&retry=%s" retry)
"")
(if expire
(format "&expire=%s" expire)
""))))
(url-retrieve "https://api.pushover.net/1/messages.json" (lambda (status) (kill-buffer (current-buffer)) t))))
(provide 'pushover)
;;; pushover.el ends here
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment