This is the humbler Reference Manual, version 2.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:25:13 2024 GMT+0.
humbler/humbler.asdhumbler/package.lisphumbler/toolkit.lisphumbler/auth.lisphumbler/blog.lisphumbler/posts.lisphumbler/post.lisphumbler/user.lisphumbler/tagged.lisphumbler/objects.lisphumbler/object-bridge.lisphumbler/generics.lisphumbler/deferring.lisphumbler/documentation.lispThe main system appears first, followed by any subsystem dependency.
humblerA Tumblr API interface
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/humbler.git)
zlib
2.0.0
north-core (system).
yason (system).
trivial-mimes (system).
local-time (system).
closer-mop (system).
cl-ppcre (system).
package.lisp (file).
toolkit.lisp (file).
auth.lisp (file).
blog.lisp (file).
posts.lisp (file).
post.lisp (file).
user.lisp (file).
tagged.lisp (file).
objects.lisp (file).
object-bridge.lisp (file).
generics.lisp (file).
deferring.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
humbler/humbler.asdhumbler/package.lisphumbler/toolkit.lisphumbler/auth.lisphumbler/blog.lisphumbler/posts.lisphumbler/post.lisphumbler/user.lisphumbler/tagged.lisphumbler/objects.lisphumbler/object-bridge.lisphumbler/generics.lisphumbler/deferring.lisphumbler/documentation.lisphumbler/toolkit.lisppackage.lisp (file).
humbler (system).
*tumblr-datetime-format* (special variable).
format-tumblr-date (function).
from-keyword (function).
get-unix-time (function).
pageinate (function).
pageinate-id (function).
pageinate-time (function).
parse-tumblr-date (function).
prepare (function).
prepare* (macro).
print-slots (function).
to-keyword (function).
*unix-epoch-difference* (special variable).
aget (function).
random-port (function).
humbler/auth.lisptoolkit.lisp (file).
humbler (system).
*client* (special variable).
*oauth/access-token* (special variable).
*oauth/authorize* (special variable).
*oauth/request-token* (special variable).
*user* (special variable).
*user* (function).
client (class).
login (function).
logout (function).
raw-request (function).
request (function).
data-request (function).
handle-hunchentoot (function).
raw-data-request (function).
start-hunchentoot-server (function).
with-maybe-drakma-handling (macro).
humbler/blog.lispauth.lisp (file).
humbler (system).
blog/avatar (function).
blog/followers (function).
blog/info (function).
blog/likes (function).
*blog/avatar* (special variable).
*blog/followers* (special variable).
*blog/info* (special variable).
*blog/likes* (special variable).
humbler/posts.lispblog.lisp (file).
humbler (system).
blog/posts (function).
blog/posts/draft (function).
blog/posts/queue (function).
blog/posts/submission (function).
*blog/posts* (special variable).
*blog/posts/draft* (special variable).
*blog/posts/queue* (special variable).
*blog/posts/submission* (special variable).
humbler/post.lispposts.lisp (file).
humbler (system).
blog/post-audio (function).
blog/post-chat (function).
blog/post-link (function).
blog/post-photo (function).
blog/post-quote (function).
blog/post-text (function).
blog/post-video (function).
blog/post/delete (function).
blog/post/edit (function).
blog/post/reblog (function).
%post-fun-header (macro).
*blog/post* (special variable).
*blog/post/delete* (special variable).
*blog/post/edit* (special variable).
*blog/post/reblog* (special variable).
post-wrapper (function).
humbler/user.lisppost.lisp (file).
humbler (system).
user/dashboard (function).
user/follow (function).
user/following (function).
user/info (function).
user/like (function).
user/likes (function).
user/unfollow (function).
user/unlike (function).
*user/dashboard* (special variable).
*user/follow* (special variable).
*user/following* (special variable).
*user/info* (special variable).
*user/like* (special variable).
*user/likes* (special variable).
*user/unfollow* (special variable).
*user/unlike* (special variable).
humbler/tagged.lispuser.lisp (file).
humbler (system).
tagged (function).
*tagged* (special variable).
humbler/objects.lisptagged.lisp (file).
humbler (system).
admin (method).
album (method).
album-art (method).
answer (method).
(setf answer) (writer method).
answer-post (class).
answer-post-p (function).
artist (method).
ask-anon (method).
ask-p (reader method).
ask-page-title (method).
asking-name (method).
asking-url (method).
audio-post (class).
audio-post-p (function).
avatar (method).
blog (class).
blog-name (method).
blog-p (function).
blogs (method).
body (method).
body (method).
(setf body) (writer method).
(setf body) (writer method).
bookmarklet (method).
can-send-fan-mail (method).
caption (reader method).
caption (method).
caption (method).
caption (method).
(setf caption) (writer method).
(setf caption) (writer method).
(setf caption) (writer method).
(setf caption) (writer method).
chat-post (class).
chat-post-p (function).
content (reader method).
current-p (reader method).
date (method).
(setf date) (writer method).
default-post-format (method).
description (method).
description (method).
(setf description) (writer method).
dialogue (method).
dialogue (class).
dialogue-p (function).
draft-count (method).
embed-code (reader method).
facebook-opengraph-enabled (method).
file (reader method).
file (reader method).
file (reader method).
(setf file) (writer method).
(setf file) (writer method).
(setf file) (writer method).
followed (method).
height (reader method).
height (method).
id (method).
label (reader method).
like-count (method).
liked (method).
link-post (class).
link-post-p (function).
message-count (method).
mobile (method).
name (reader method).
name (reader method).
note-count (reader method).
nsfw-p (reader method).
photo (class).
photo-p (function).
photo-post (class).
photo-post-p (function).
photo-size (class).
photo-size-p (function).
photos (reader method).
photos (method).
(setf photos) (writer method).
(setf photos) (writer method).
phrase (reader method).
play-count (method).
player (method).
players (method).
post (class).
post-count (method).
post-format (method).
(setf post-format) (writer method).
post-p (function).
post-type (method).
post-url (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
question (method).
queue-count (method).
quote-post (class).
quote-post-p (function).
raw-content (reader method).
reblog-key (method).
root-p (reader method).
share-likes (method).
sizes (reader method).
slug (method).
(setf slug) (writer method).
source (method).
(setf source) (writer method).
source-title (method).
source-url (method).
state (method).
(setf state) (writer method).
summary (reader method).
tags (method).
(setf tags) (writer method).
text (method).
(setf text) (writer method).
text-format (method).
(setf text-format) (writer method).
text-post (class).
text-post-p (function).
timestamp (method).
title (method).
title (method).
title (method).
title (method).
(setf title) (writer method).
(setf title) (writer method).
(setf title) (writer method).
track-name (method).
track-number (method).
trail (reader method).
trail (class).
trail-blog (reader method).
trail-p (function).
trail-post (reader method).
tweet (method).
(setf tweet) (writer method).
twitter-enabled (method).
twitter-send (method).
updated (method).
url (reader method).
url (method).
url (method).
(setf url) (writer method).
user (class).
user-p (function).
video-player (class).
video-player-p (function).
video-post (class).
video-post-p (function).
width (reader method).
width (reader method).
width (method).
year (method).
define-predicates (macro).
following-count (method).
short-url (reader method).
humbler/object-bridge.lispobjects.lisp (file).
humbler (system).
make-blog (function).
make-dialogue (function).
make-photo (function).
make-photo-size (function).
make-post (function).
make-trail (function).
make-user (function).
make-video-player (function).
daget (function).
field-getter (function).
field-iterator (function).
kaget (function).
make-from-result (function).
make-raw-post (function).
map-field (function).
map-field-list (function).
naget (function).
saget (function).
taget (function).
humbler/generics.lispobject-bridge.lisp (file).
humbler (system).
augment (generic function).
blog (generic function).
blog= (generic function).
copy (generic function).
dashboard (generic function).
destroy (generic function).
drafts (generic function).
follow (generic function).
followers (generic function).
following (generic function).
like (generic function).
likes (generic function).
my-blogs (generic function).
my-drafts (generic function).
my-followers (generic function).
my-likes (generic function).
my-posts (generic function).
my-queue (generic function).
my-submissions (generic function).
myself (generic function).
post (generic function).
post= (generic function).
posts (generic function).
queue (generic function).
reblog (generic function).
reblog-p (generic function).
refresh (generic function).
reply (generic function).
repost (generic function).
save (generic function).
submissions (generic function).
tag (generic function).
unfollow (generic function).
unlike (generic function).
%edit-post (function).
%save-post (function).
humbler/deferring.lispgenerics.lisp (file).
humbler (system).
admin (reader method).
album (method).
album (reader method).
album-art (method).
album-art (reader method).
answer (method).
answer (reader method).
artist (method).
artist (reader method).
ask-anon (reader method).
ask-page-title (reader method).
asking-name (reader method).
asking-url (method).
asking-url (reader method).
avatar (reader method).
blog-name (reader method).
blogs (reader method).
body (method).
body (reader method).
body (reader method).
bookmarklet (reader method).
can-send-fan-mail (reader method).
caption (method).
caption (reader method).
caption (reader method).
caption (reader method).
date (reader method).
default-post-format (reader method).
description (method).
description (reader method).
description (reader method).
dialogue (method).
dialogue (reader method).
draft-count (reader method).
facebook-opengraph-enabled (reader method).
file (method).
followed (reader method).
height (method).
height (reader method).
id (reader method).
like-count (reader method).
liked (reader method).
message-count (reader method).
mobile (reader method).
photos (method).
photos (reader method).
play-count (method).
play-count (reader method).
player (method).
player (reader method).
players (method).
players (reader method).
post-count (reader method).
post-format (reader method).
post-type (reader method).
post-url (reader method).
question (method).
question (reader method).
queue-count (reader method).
reblog-key (reader method).
share-likes (reader method).
slug (reader method).
source (method).
source (reader method).
source-title (reader method).
source-url (reader method).
state (reader method).
tags (reader method).
text (reader method).
text-format (reader method).
timestamp (reader method).
title (method).
title (reader method).
title (reader method).
title (reader method).
title (reader method).
track-name (method).
track-name (reader method).
track-number (method).
track-number (reader method).
tweet (reader method).
twitter-enabled (reader method).
twitter-send (reader method).
updated (reader method).
url (method).
url (reader method).
url (reader method).
width (method).
width (reader method).
year (method).
year (reader method).
ask (method).
askin-name (method).
following-count (reader method).
is-nsfw (method).
set-deferred (macro).
set-post-deferred (macro).
set-undeferred (macro).
humbler/documentation.lispdeferring.lisp (file).
humbler (system).
docc (macro).
docf (macro).
post-docstring (function).
Packages are listed by definition order.
humbler-extraorg.tymoonnext.humbler.extra
*client* (special variable).
*oauth/access-token* (special variable).
*oauth/authorize* (special variable).
*oauth/request-token* (special variable).
*tumblr-datetime-format* (special variable).
*user* (special variable).
*user* (function).
client (class).
format-tumblr-date (function).
from-keyword (function).
get-unix-time (function).
login (function).
logout (function).
pageinate (function).
pageinate-id (function).
pageinate-time (function).
parse-tumblr-date (function).
prepare (function).
prepare* (macro).
print-slots (function).
raw-request (function).
request (function).
to-keyword (function).
humbler-apiorg.tymoonnext.humbler.api
blog/avatar (function).
blog/followers (function).
blog/info (function).
blog/likes (function).
blog/post-audio (function).
blog/post-chat (function).
blog/post-link (function).
blog/post-photo (function).
blog/post-quote (function).
blog/post-text (function).
blog/post-video (function).
blog/post/delete (function).
blog/post/edit (function).
blog/post/reblog (function).
blog/posts (function).
blog/posts/draft (function).
blog/posts/queue (function).
blog/posts/submission (function).
tagged (function).
user/dashboard (function).
user/follow (function).
user/following (function).
user/info (function).
user/like (function).
user/likes (function).
user/unfollow (function).
user/unlike (function).
humbler-objectsorg.tymoonnext.humbler.objects
admin (generic function).
album (generic function).
album-art (generic function).
answer (generic function).
(setf answer) (generic writer).
answer-post (class).
answer-post-p (function).
artist (generic function).
ask-anon (generic function).
ask-p (generic reader).
ask-page-title (generic function).
asking-name (generic function).
asking-url (generic function).
audio-post (class).
audio-post-p (function).
augment (generic function).
avatar (generic function).
blog (generic function).
blog (class).
blog-name (generic function).
blog-p (function).
blog= (generic function).
blogs (generic function).
body (generic function).
(setf body) (generic writer).
bookmarklet (generic function).
can-send-fan-mail (generic function).
caption (generic function).
(setf caption) (generic writer).
chat-post (class).
chat-post-p (function).
content (generic reader).
copy (generic function).
current-p (generic reader).
dashboard (generic function).
date (generic function).
(setf date) (generic writer).
default-post-format (generic function).
description (generic function).
(setf description) (generic writer).
destroy (generic function).
dialogue (generic function).
dialogue (class).
dialogue-p (function).
draft-count (generic function).
drafts (generic function).
embed-code (generic reader).
facebook-opengraph-enabled (generic function).
file (generic function).
(setf file) (generic writer).
follow (generic function).
followed (generic function).
followers (generic function).
following (generic function).
height (generic function).
id (generic function).
label (generic reader).
like (generic function).
like-count (generic function).
liked (generic function).
likes (generic function).
link-post (class).
link-post-p (function).
make-blog (function).
make-dialogue (function).
make-photo (function).
make-photo-size (function).
make-post (function).
make-trail (function).
make-user (function).
make-video-player (function).
message-count (generic function).
mobile (generic function).
my-blogs (generic function).
my-drafts (generic function).
my-followers (generic function).
my-likes (generic function).
my-posts (generic function).
my-queue (generic function).
my-submissions (generic function).
myself (generic function).
name (generic reader).
note-count (generic reader).
nsfw-p (generic reader).
photo (class).
photo-p (function).
photo-post (class).
photo-post-p (function).
photo-size (class).
photo-size-p (function).
photos (generic function).
(setf photos) (generic writer).
phrase (generic reader).
play-count (generic function).
player (generic function).
players (generic function).
post (generic function).
post (class).
post-count (generic function).
post-format (generic function).
(setf post-format) (generic writer).
post-p (function).
post-type (generic function).
post-url (generic function).
post= (generic function).
posts (generic function).
question (generic function).
queue (generic function).
queue-count (generic function).
quote-post (class).
quote-post-p (function).
raw-content (generic reader).
reblog (generic function).
reblog-key (generic function).
reblog-p (generic function).
refresh (generic function).
reply (generic function).
repost (generic function).
root-p (generic reader).
save (generic function).
share-likes (generic function).
sizes (generic reader).
slug (generic function).
(setf slug) (generic writer).
source (generic function).
(setf source) (generic writer).
source-title (generic function).
source-url (generic function).
state (generic function).
(setf state) (generic writer).
submissions (generic function).
summary (generic reader).
tag (generic function).
tags (generic function).
(setf tags) (generic writer).
text (generic function).
(setf text) (generic writer).
text-format (generic function).
(setf text-format) (generic writer).
text-post (class).
text-post-p (function).
timestamp (generic function).
title (generic function).
(setf title) (generic writer).
track-name (generic function).
track-number (generic function).
trail (generic reader).
trail (class).
trail-blog (generic reader).
trail-p (function).
trail-post (generic reader).
tweet (generic function).
(setf tweet) (generic writer).
twitter-enabled (generic function).
twitter-send (generic function).
unfollow (generic function).
unlike (generic function).
updated (generic function).
url (generic function).
(setf url) (generic writer).
user (class).
user-p (function).
video-player (class).
video-player-p (function).
video-post (class).
video-post-p (function).
width (generic function).
year (generic function).
humblerorg.tymoonnext.humbler
common-lisp.
humbler-api.
humbler-extra.
humbler-objects.
%edit-post (function).
%post-fun-header (macro).
%save-post (function).
*blog/avatar* (special variable).
*blog/followers* (special variable).
*blog/info* (special variable).
*blog/likes* (special variable).
*blog/post* (special variable).
*blog/post/delete* (special variable).
*blog/post/edit* (special variable).
*blog/post/reblog* (special variable).
*blog/posts* (special variable).
*blog/posts/draft* (special variable).
*blog/posts/queue* (special variable).
*blog/posts/submission* (special variable).
*tagged* (special variable).
*unix-epoch-difference* (special variable).
*user/dashboard* (special variable).
*user/follow* (special variable).
*user/following* (special variable).
*user/info* (special variable).
*user/like* (special variable).
*user/likes* (special variable).
*user/unfollow* (special variable).
*user/unlike* (special variable).
aget (function).
ask (generic function).
askin-name (generic function).
daget (function).
data-request (function).
define-predicates (macro).
docc (macro).
docf (macro).
field-getter (function).
field-iterator (function).
following-count (slot).
following-count (generic function).
handle-hunchentoot (function).
is-nsfw (generic function).
kaget (function).
make-from-result (function).
make-raw-post (function).
map-field (function).
map-field-list (function).
naget (function).
post-docstring (function).
post-wrapper (function).
random-port (function).
raw-data-request (function).
saget (function).
set-deferred (macro).
set-post-deferred (macro).
set-undeferred (macro).
short-url (slot).
short-url (generic reader).
start-hunchentoot-server (function).
taget (function).
with-maybe-drakma-handling (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The client object used to access the Tumblr API.
Local-time format to produce tumblr’s datetime format.
The central user object storing a reference to whoever is currently logged in.
Note that accessing this variable directly might result in NIL
even if the oAuth handshake has been completed. Use (*USER*),
the function, instead to ensure that the returned value is valid.
Creates a PREPARE statement out of the provided variables.
Returns the central user object that the client is authenticated as.
Returns the avatar image as a PNG octet-sequence.
SIZE — The size of the avatar to return, one of 16 24 30 40 48 64 96 128 512
Returns a list of followers of this blog.
Secondary value returns the total number of followers.
LIMIT — The number of posts to include, must range between 1 and 20.
OFFSET — The offset in posts to return.
Each object in the list has the following fields:
NAME — The user’s name.
FOLLOWING — T if you are following this user, NIL otherwise.
URL — The address to the primary blog of this user.
UPDATED — Unix-time of the last update of this user.
Returns information about a blog.
Included fields:
TITLE — The title of the blog.
POSTS — Total number of posts on this blog.
NAME — The blog username.
UPDATED — Unix-Time of the last update.
DESCRIPTION — The blog’s description.
ASK — T if asks are enabled, NIL otherwise.
ASK-ANON — T if anonymous asks are allowed, NIL otherwise.
Only included if ASK is T.
LIKES — The number of posts this user has liked.
Only included if likes sharing is enabled and this blog
is indeed a user.
Returns a list of publicly shown posts that were liked by this blog.
Secondary value returns the total number of liked posts.
LIMIT — The number of posts to include, must range between 1 and 20.
OFFSET — The offset in posts to return.
See BLOG/POSTS for information on the structure of a post object.
Creates a audio post and returns the post’s ID.
Required arguments:
BLOG — string
The name of the blog to post to. Your account has to have access
to this blog in order for the post to succeed.
AUDIO ::= string | pathname | octet-array
If a string, it should be an external URL that hosts the file.
Otherwise a pathname/octet-array of an MP3 file.
Optional arguments:
CAPTION — string
The caption to describe the audio with.
STATE ::= :published | :draft | :queue | :private
Sets the state of the post, can later be changed through BLOG/POST/EDIT.
TAGS ::= string | list
Either a list or a comma-separated string of tags.
TWEET ::= string | :off
If :off no tweet is made, if a string is given it is used as the tweet text.
DATE ::= string | local-time:timestamp
’The GMT date and time of the post’ according to doc, but no further
specification of what the format is supposed to be exactly. According to
date fields in responses, it should probably be of the format
’2014-08-31 07:41:44 GMT’
FORMAT ::= :html | :markdown
Specifies the markup in the text body, quote, caption, or whatever the current
text-block container is.
SLUG — string
A short string to use at the end of the URL to the post.
Creates a chat post and returns the post’s ID.
Required arguments:
BLOG — string
The name of the blog to post to. Your account has to have access
to this blog in order for the post to succeed.
CONVERSATION– string
The conversation to post.
Optional arguments:
TITLE — string
The title to use for your conversation post.
STATE ::= :published | :draft | :queue | :private
Sets the state of the post, can later be changed through BLOG/POST/EDIT.
TAGS ::= string | list
Either a list or a comma-separated string of tags.
TWEET ::= string | :off
If :off no tweet is made, if a string is given it is used as the tweet text.
DATE ::= string | local-time:timestamp
’The GMT date and time of the post’ according to doc, but no further
specification of what the format is supposed to be exactly. According to
date fields in responses, it should probably be of the format
’2014-08-31 07:41:44 GMT’
FORMAT ::= :html | :markdown
Specifies the markup in the text body, quote, caption, or whatever the current
text-block container is.
SLUG — string
A short string to use at the end of the URL to the post.
Creates a link post and returns the post’s ID.
Required arguments:
BLOG — string
The name of the blog to post to. Your account has to have access
to this blog in order for the post to succeed.
URL — string
The link to post.
Optional arguments:
TITLE — string
The title to use for your url post. If not specified automatically
grabbed from the URL source page.
DESCRIPTION— string
Optional description text to use along your URL. If not specified
automatically grabbed from the URL source page.
STATE ::= :published | :draft | :queue | :private
Sets the state of the post, can later be changed through BLOG/POST/EDIT.
TAGS ::= string | list
Either a list or a comma-separated string of tags.
TWEET ::= string | :off
If :off no tweet is made, if a string is given it is used as the tweet text.
DATE ::= string | local-time:timestamp
’The GMT date and time of the post’ according to doc, but no further
specification of what the format is supposed to be exactly. According to
date fields in responses, it should probably be of the format
’2014-08-31 07:41:44 GMT’
FORMAT ::= :html | :markdown
Specifies the markup in the text body, quote, caption, or whatever the current
text-block container is.
SLUG — string
A short string to use at the end of the URL to the post.
Creates a photo post and returns the post’s ID.
Required arguments:
BLOG — string
The name of the blog to post to. Your account has to have access
to this blog in order for the post to succeed.
PHOTO ::= string | pathname | octet-array | (pathname* octet-array*)
If a string, it should be an URL to the photo to be posted.
Otherwise a pathname/octet-array or a list thereof to compose
the photo or photo-set.
Optional arguments:
CAPTION — string
The caption to describe the photo/set with.
LINK — string
An optional link to use for when the image is clicked on.
STATE ::= :published | :draft | :queue | :private
Sets the state of the post, can later be changed through BLOG/POST/EDIT.
TAGS ::= string | list
Either a list or a comma-separated string of tags.
TWEET ::= string | :off
If :off no tweet is made, if a string is given it is used as the tweet text.
DATE ::= string | local-time:timestamp
’The GMT date and time of the post’ according to doc, but no further
specification of what the format is supposed to be exactly. According to
date fields in responses, it should probably be of the format
’2014-08-31 07:41:44 GMT’
FORMAT ::= :html | :markdown
Specifies the markup in the text body, quote, caption, or whatever the current
text-block container is.
SLUG — string
A short string to use at the end of the URL to the post.
Creates a quote post and returns the post’s ID.
Required arguments:
BLOG — string
The name of the blog to post to. Your account has to have access
to this blog in order for the post to succeed.
QUOTE — string
The quote to use, marked up in FORMAT.
Optional arguments:
SOURCE — string
Quote source attribution.
STATE ::= :published | :draft | :queue | :private
Sets the state of the post, can later be changed through BLOG/POST/EDIT.
TAGS ::= string | list
Either a list or a comma-separated string of tags.
TWEET ::= string | :off
If :off no tweet is made, if a string is given it is used as the tweet text.
DATE ::= string | local-time:timestamp
’The GMT date and time of the post’ according to doc, but no further
specification of what the format is supposed to be exactly. According to
date fields in responses, it should probably be of the format
’2014-08-31 07:41:44 GMT’
FORMAT ::= :html | :markdown
Specifies the markup in the text body, quote, caption, or whatever the current
text-block container is.
SLUG — string
A short string to use at the end of the URL to the post.
Creates a text post and returns the post’s ID.
Required arguments:
BLOG — string
The name of the blog to post to. Your account has to have access
to this blog in order for the post to succeed.
BODY — string
The main post body, marked up in FORMAT.
Optional arguments:
TITLE — string
The title to use for your text post.
STATE ::= :published | :draft | :queue | :private
Sets the state of the post, can later be changed through BLOG/POST/EDIT.
TAGS ::= string | list
Either a list or a comma-separated string of tags.
TWEET ::= string | :off
If :off no tweet is made, if a string is given it is used as the tweet text.
DATE ::= string | local-time:timestamp
’The GMT date and time of the post’ according to doc, but no further
specification of what the format is supposed to be exactly. According to
date fields in responses, it should probably be of the format
’2014-08-31 07:41:44 GMT’
FORMAT ::= :html | :markdown
Specifies the markup in the text body, quote, caption, or whatever the current
text-block container is.
SLUG — string
A short string to use at the end of the URL to the post.
Creates a video post and returns the post’s ID.
Required arguments:
BLOG — string
The name of the blog to post to. Your account has to have access
to this blog in order for the post to succeed.
VIDEO ::= string | pathname | octet-array
If a string, it should be the HTML embed-code for the video.
Otherwise a pathname/octet-array of an MP4 video with AAC audio encoding.
Optional arguments:
CAPTION — string
THe caption to describe the video with.
STATE ::= :published | :draft | :queue | :private
Sets the state of the post, can later be changed through BLOG/POST/EDIT.
TAGS ::= string | list
Either a list or a comma-separated string of tags.
TWEET ::= string | :off
If :off no tweet is made, if a string is given it is used as the tweet text.
DATE ::= string | local-time:timestamp
’The GMT date and time of the post’ according to doc, but no further
specification of what the format is supposed to be exactly. According to
date fields in responses, it should probably be of the format
’2014-08-31 07:41:44 GMT’
FORMAT ::= :html | :markdown
Specifies the markup in the text body, quote, caption, or whatever the current
text-block container is.
SLUG — string
A short string to use at the end of the URL to the post.
Delete the post with the given ID.
Returns the post’s ID.
Edit the post with the given ID.
See the individual BLOG/POST-* functions for the argument explanations.
Returns the post ID.
Reblog the post with the given ID on the specified BLOG.
ID — The post’s unique ID.
REBLOG-KEY — The reblog-key for this post (See BLOG/POSTS)
COMMENT — An optional comment to add to the reblog.
Returns the reblog’s post ID.
Returns a list of posts from the blog.
Secondary value contains the total number of posts on the blog.
Tertiary value contains the blog object. See BLOG/INFO.
TYPE — The type of posts to include, must be one of
:text :quote :link :answer :video :audio :photo :chat
ID — If specified with a post-id, only that particular post is
returned.
TAG — Filter posts by a tag.
LIMIT — The number of posts to include, must range between 1 and 20.
OFFSET — The offset in posts to return.
REBLOG-INFO — Whether to return the various ’reblogged-’ fields.
NOTES-INFO — Whether to return note count and metadata.
FILTER — The post format to return, either NIL for HTML, :text for
HTML-stripped text, or :raw for the text the user entered.
A post object contains the following fields:
BLOG-NAME — The hostname of the blog.
ID — The unique post-ID.
POST-URL — Direct URL to the post.
TYPE — The type of the post as a string.
TIMESTAMP — Unix-Timestamp of the post’s creation date.
DATE — The ’GMT-formatted’ version of the creation date.
FORMAT — Either ’html’ or ’markdown’.
REBLOG-KEY — The key necessary to reblog this post.
TAGS — The list of tags as strings.
BOOKMARKLET — Only exists if true, signals that the post was made
using the tumblr bookmarklet.
MOBILE — Onlx exists if true, signals that the post was made
using mobile or email publishing.
SOURCE-URL — The source address of quotes, reblogs, etc. Exists only
if there is a source.
SOURCE-TITLE — The title of the source site, exists only if there is a
source.
LIKED — T if you have liked this post, NIL otherwise.
Only exists if you have been logged in.
STATE — The state of the post, one of ’published’ ’queued’ ’draft’
or ’private’.
Text-post attributes:
TITLE — The title of the post
BODY — The text-post’s content.
Photo-post attributes:
PHOTOS — A list of photo objects with the following properties:
CAPTION — Caption for this particular photo.
ALT-SIZES — List of size objects with the following properties:
WIDTH — The exact width of this size in pixels.
HEIGHT — The exact height of this size in pixels.
URL — The URL pointing to this image size.
CAPTION — The caption for this photo/set.
WIDTH — Width of the photo/set.
HEIGHT — Height of the photo/set.
Quote-post attributes:
TEXT — The quote text.
SOURCE — HTML of the supplied, supposed quote source.
Link-post attributes:
TITLE — The title of the page the link points to.
URL — The actual address of the link.
DESCRIPTION — An optional description supplied by the user.
Chat-post attributes:
TITLE — Optional title of the conversation.
BODY — The full conversation.
DIALOGUE — List of objects with the following properties:
LABEL — Conversation entry label.
NAME — Name of the speaker.
PHRASE — Actual dialogue sentence.
Audio-post attributes:
CAPTION — The caption the user supplied for the audio post.
PLAYER — HTML player embed code.
PLAYS — Counter for the number of times this has been played.
ALBUM-ART — URL to the album-art image of the track. [ID3]
ARTIST — The track’s artist. [ID3]
ALBUM — The track’s album. [ID3]
TRACK-NAME — The name of the track. [ID3]
TRACK-NUMBER — The ordering number of the track. [ID3]
YEAR — The publishing year of the track. [ID3]
Video-post attributes:
CAPTION — The caption for the video post.
PLAYER — A list of players with the following properties:
WIDTH — The width of the player object.
EMBED-CODE — The HTML embed code for the video player.
Answer-post attributes:
ASKING-NAME — The name of the blog that asked the question.
ASKING-URL — Full URL to the asker’s blog.
QUESTION — The actual question text.
ANSWER — Full text of the answer.
Returns the list of drafts on the blog.
See BLOG/POSTS for the post object structure.
BEFORE-ID — Returns posts that appear after this ID.
FILTER — The post format to return, either NIL for HTML, :text for
HTML-stripped text, or :raw for the text the user entered.
Returns the list of posts in the blog’s queue.
See BLOG/POSTS for the post object structure.
LIMIT — The number of posts to include, must range between 1 and 20.
OFFSET — The offset in posts to return.
FILTER — The post format to return, either NIL for HTML, :text for
HTML-stripped text, or :raw for the text the user entered.
Returns the list of submitted posts and asks.
See BLOG/POSTS for the post object structure.
OFFSET — The offset in posts to return.
FILTER — The post format to return, either NIL for HTML, :text for
HTML-stripped text, or :raw for the text the user entered.
Returns a string version of the local-time timestamp using the proper timezone and format.
Turns a keyword into a key.
Replaces - with _ and downcases the keyword as a string.
This is useful to parse the request parameters from the
lisp representation into the api representation.
Returns an integer representing the seconds since the unix epoch.
Performs a login with North.
This will load Hunchentoot and spawn an HTTP server if the client’s callback is :SPAWN. The server will be automatically torn down again once the oAuth handshake is complete.
Resets the *client* and *user* to NIL, thus logging you out.
Gather results from FUNCTION until AMOUNT is gathered.
The function needs to accept both OFFSET and LIMIT keywords.
As per default for tumblr calls, the objects are gathered in
steps of twenty.
AMOUNT can be a positive integer or T for as many as possible.
The returned set may be less than the requested amount.
Gather results from FUNCTION until AMOUNT is gathered.
The function needs to accept a BEFORE-ID keyword and return
a list of objects that have an ID slot accessible through
the ID reader.
AMOUNT can be a positive integer or T for as many as possible.
The returned set may be less than the requested amount.
Gather results from FUNCTION until AMOUNT is gathered.
The function needs to accept a BEFORE keyword and return
a list of objects that have a TIMESTAMP slot accessible
through the TIMESTAMP reader.
AMOUNT can be a positive integer or T for as many as possible.
The returned set may be less than the requested amount.
Parses a tumblr datestring (2014-08-01 23:52:31 GMT) into a local-time timestamp. If it fails to parse, the datestring is returned instead.
Filters out empty key-value pairs and turns all values into strings, ready to be sent out as request parameters. This function is DESTRUCTIVE.
Prints all slots of the object and their values.
Performs a raw request, with JSON as text.
URL — Url to request
METHOD — Request method
PARAMETERS — List of parameters
OAUTH — Whether to use oAuth signing or not.
Wrapper around RAW-REQUEST, automatically parsing the JSON or producing a nice error on failure.
Returns the list of posts under the given tag.
See BLOG/POSTS for the post object structure.
TAG — The tag to filter for.
BEFORE — A Unix-Timestamp from before which time you’d like to get
posts returned. Defaults to the current time.
LIMIT — The number of posts to include, must range between 1 and 20.
FILTER — The post format to return, either NIL for HTML, :text for
HTML-stripped text, or :raw for the text the user entered.
Turns a key into a keyword.
Replaces _ with - and uppercases the string, then interns it
into the keyword package. This is useful to parse the request
responses into an alist.
Returns a list of posts on your dashboard.
See BLOG/POSTS for the post object structure.
LIMIT — The number of posts to include, must range between 1 and 20.
OFFSET — The offset in posts to return.
TYPE — The type of posts to include, must be one of
:text :quote :link :answer :video :audio :photo :chat
SINCE-ID — Return only posts appearing after this post-ID.
REBLOG-INFO — Whether to return the various ’reblogged-’ fields.
NOTES-INFO — Whether to return note count and metadata.
Follow a blog.
BLOG — The blog’s short name.
Returns T on success.
Returns a list of blogs you follow.
LIMIT — The number of posts to include, must range between 1 and 20.
OFFSET — The offset in posts to return.
A blog object contains the following properties:
DESCRIPTION — The blog’s description text.
UPDATED — Unix-Timestamp of the last update.
TITLE — Title used on the blog’s page.
NAME — The blog’s short name.
URL — The full URL to the blog.
Returns information about yourself.
FOLLOWING — Counter for the number of blogs you are following.
DEFAULT-POST-FORMAT The default format to use for posting, one of
’html’ ’markdown’ ’raw’
NAME — The short name of the user.
LIKES — Counter for the number of likes.
BLOGS — A list of blog objects with the following properties:
NAME — Short name of the blog.
URL — The full URL to the blog.
TITLE — The title string used on the blog.
PRIMARY — T if this is the user’s primary blog, NIL otherwise.
FOLLOWERS — Counter for the number of followers on this blog.
TWEET — String denoting what to do with tweets (?)
One of ’Y’ ’N’ ’auto’, but idk what the difference
between ’Y’ and ’auto’ is, so.
FACEBOOK — Whether to send posts to facebook, either ’Y’ or ’N’.
TYPE — Either ’public’ or ’private’.
!! OFFICIALLY UNDOCUMENTED PROPERTIES
The following BLOG properties are also included in a request:
DRAFTS — Number of drafts on the blog.
QUEUE — Number of posts queued up.
MESSAGES — The number of messages (asks) received.
ADMIN — Whether you are an administrator of the blog.
FACEBOOK-OPENGRAPH-ENABLED No idea wtf this is.
TWITTER-SEND — Probably whether to send twitter messages? No idea.
TWITTER-ENABLED — Whether twitter was linked or not, most likely.
LIKES — The number of posts this user-blog has liked.
SHARE-LIKES — T if likes are shared, NIL otherwise.
CAN-SEND-FAN-MAIL - Whether this blog can send fan mail (?)
FOLLOWED — Not sure, maybe whether the blog follows you?
ASK-ANON — Whether anon-asks are allowed.
ASK-PAGE-TITLE — The ask-page title.
ASK — Whether asks are enabled.
IS-NSFW — T if this is a NSFW-blog.
DESCRIPTION — The blog’s description.
UPDATED — Unix-Timestamp of the last update.
POSTS — Counter for the number of posts on this blog.
Like a post.
ID — The post’s unique ID.
REBLOG-KEY — The reblog-key for this post (See BLOG/POSTS)
Returns T on success.
Returns a list of posts you liked.
See BLOG/POSTS for the post object structure.
LIMIT — The number of posts to include, must range between 1 and 20. OFFSET — The offset in posts to return.
Unfollow a blog.
BLOG — The blog’s short name.
Returns T on success.
Unlike a post.
ID — The post’s unique ID.
REBLOG-KEY — The reblog-key for this post (See BLOG/POSTS)
Returns T on success.
audio-post)) ¶audio-post)) ¶automatically generated reader method
audio-post)) ¶audio-post)) ¶automatically generated reader method
answer-post)) ¶answer-post)) ¶automatically generated reader method
answer-post)) ¶automatically generated writer method
audio-post)) ¶audio-post)) ¶automatically generated reader method
answer-post)) ¶answer-post)) ¶automatically generated reader method
answer-post)) ¶answer-post)) ¶automatically generated reader method
Fills up slots in TARGET with information from SOURCE.
Tries to fetch the blog object given by NAME.
If a blog object is passed, the same post is fetched anew and the new copy is returned. The old is left intact.
Returns a blog object or NIL if no blog could be found.
string)) ¶Returns T if the two blogs match in name, NIL otherwise.
string) (b string)) ¶video-post)) ¶audio-post)) ¶photo-post)) ¶video-post)) ¶automatically generated reader method
audio-post)) ¶automatically generated reader method
photo-post)) ¶automatically generated reader method
photo)) ¶automatically generated writer method
video-post)) ¶automatically generated writer method
audio-post)) ¶automatically generated writer method
photo-post)) ¶automatically generated writer method
Attempts to copy the passed object by creating a new instance of the same class and then calling AUGMENT on it. Note that since AUGMENT does not copy fields, this is NOT a deep copy and thus slot values are shared!
Retrieve a list of posts on your dashboard.
If AMOUNT is above twenty, multiple requests are made in order to gather the desired amount automatically.
Delete the given post.
Returns the post object on success, signals an error on failure.
Retrieve a list of drafted posts if possible.
If AMOUNT is above twenty, multiple requests are made in order to gather the desired amount automatically.
string) &key amount offset before-id) ¶video-player)) ¶automatically generated reader method
video-post)) ¶automatically generated reader method
file.
audio-post)) ¶automatically generated reader method
file.
photo-post)) ¶automatically generated reader method
file.
video-post)) ¶automatically generated writer method
file.
audio-post)) ¶automatically generated writer method
file.
photo-post)) ¶automatically generated writer method
file.
Follow the given blog.
Returns the blog on success, signals an error on failure.
string)) ¶Returns a list of USER objects that follow the given blog.
If AMOUNT is above twenty, multiple requests are made in order to gather the desired amount automatically.
string) &key amount offset) ¶Retrieve a list of blogs that you are following.
If AMOUNT is above twenty, multiple requests are made in order to gather the desired amount automatically.
photo-post)) ¶photo-size)) ¶automatically generated reader method
photo-post)) ¶automatically generated reader method
Like the given post.
Returns the post object on success, signals an error on failure.
Retrieve a list of liked posts if possible.
If AMOUNT is above twenty, multiple requests are made in order to gather the desired amount automatically.
string) &key amount offset) ¶Shorthand for (DRAFTS *user*)
Shorthand for (FOLLOWERS *user*)
Shorthand for (LIKES *user*)
Shorthand for (POSTS *user*)
Shorthand for (QUEUE *user*)
Shorthand for (SUBMISSIONS *user*)
Retrieve information about yourself.
Returns a USER object.
photo-post)) ¶link-post)) ¶automatically generated reader method
photo-post)) ¶automatically generated reader method
link-post)) ¶automatically generated writer method
photo-post)) ¶automatically generated writer method
audio-post)) ¶audio-post)) ¶automatically generated reader method
audio-post)) ¶audio-post)) ¶automatically generated reader method
video-post)) ¶video-post)) ¶automatically generated reader method
Retrieve an individual post by its unique ID.
If a blog object is passed, the same post is fetched anew and the new copy is returned. The old is left intact.
Returns a post object or NIL if no post can be found.
fixnum) &optional blog-name) ¶Returns T if the two posts match in ID, NIL otherwise.
fixnum) (b fixnum)) ¶Retrieve a list of public posts filtered by TYPE and TAG.
If AMOUNT is above twenty, multiple requests are made in order to gather the desired amount automatically.
string) &key type tag amount offset) ¶answer-post)) ¶answer-post)) ¶automatically generated reader method
Retrieve a list of queued posts if possible.
If AMOUNT is above twenty, multiple requests are made in order to gather the desired amount automatically.
string) &key amount offset) ¶Reblog the given post.
Returns the newly created reblog post object on success, signals an error on failure.
Update the post object with newly retrieved values.
This changes the passed object’s slots. See AUGMENT.
Returns the post object on success, signals an error on failure.
answer-post) answer) ¶Creates a copy of the post object and posts it to the given blog as a new post.
Returns the repost object on success, signals an error on failure.
Note that the slot values of the repost are shared with that of the original post. See COPY.
Creates or edits the given post with the new values.
Returns the post object on success, signals an error on failure.
photo-post)) ¶quote-post)) ¶audio-post)) ¶video-post)) ¶answer-post)) ¶quote-post)) ¶quote-post)) ¶automatically generated reader method
quote-post)) ¶automatically generated writer method
Retrieve a list of submitted posts if possible.
If AMOUNT is above twenty, multiple requests are made in order to gather the desired amount automatically.
string) &key amount offset) ¶quote-post)) ¶text.
quote-post)) ¶automatically generated reader method
quote-post)) ¶automatically generated writer method
text.
chat-post)) ¶automatically generated writer method
link-post)) ¶automatically generated writer method
audio-post)) ¶audio-post)) ¶automatically generated reader method
audio-post)) ¶audio-post)) ¶automatically generated reader method
Unfollow the given blog.
Returns the blog on success, signals an error on failure.
string)) ¶Unlike the given post.
Returns the post object on success, signals an error on failure.
photo-size)) ¶automatically generated reader method
url.
photo-post)) ¶video-player)) ¶automatically generated reader method
photo-size)) ¶automatically generated reader method
photo-post)) ¶automatically generated reader method
audio-post)) ¶year.
audio-post)) ¶automatically generated reader method
photo-size) stream) ¶video-player) stream) ¶Class representing an answer post.
Class representing an audio post.
In order to change or upload audio files, please use the FILE slot. Acceptable are a string (representing the URL to a music track), a pathname or an octet vector. The file format has to be MP3.
post.
album.
album.
album-art.
album-art.
artist.
artist.
caption.
(setf caption).
caption.
(setf file).
file.
play-count.
play-count.
player.
player.
save.
track-name.
track-name.
track-number.
track-number.
year.
year.
:caption
:play-count
This slot is read-only.
:track-name
This slot is read-only.
:track-number
This slot is read-only.
Class representing a blog.
This is not equivalent to a user. Each user is necessarily also a blog, but not every blog is a user. One user may have access to multiple blogs. Pure blogs can’t follow or like anything or do any of the real-user related things, but since most of the user settings are not actually accessible through the API, the difference in slots between blogs and users is minimal.
user.
admin.
admin.
ask.
ask-anon.
ask-anon.
ask-p.
ask-page-title.
ask-page-title.
avatar.
avatar.
blog.
blog=.
blog=.
blog=.
can-send-fan-mail.
can-send-fan-mail.
description.
description.
draft-count.
draft-count.
drafts.
facebook-opengraph-enabled.
facebook-opengraph-enabled.
follow.
followed.
followed.
followers.
is-nsfw.
like-count.
like-count.
likes.
message-count.
message-count.
name.
nsfw-p.
post-count.
post-count.
posts.
print-object.
queue.
queue-count.
queue-count.
repost.
share-likes.
share-likes.
submissions.
title.
title.
twitter-enabled.
twitter-enabled.
twitter-send.
twitter-send.
unfollow.
updated.
updated.
url.
url.
:description
This slot is read-only.
:draft-count
This slot is read-only.
:queue-count
This slot is read-only.
:message-count
This slot is read-only.
:post-count
This slot is read-only.
:like-count
This slot is read-only.
:facebook-opengraph-enabled
This slot is read-only.
:twitter-send
This slot is read-only.
:twitter-enabled
This slot is read-only.
:can-send-fan-mail
This slot is read-only.
:ask-page-title
This slot is read-only.
Class representing a chat post.
client.
| Initarg | Value |
|---|---|
:callback | spawn |
:request-token-uri | *oauth/request-token* |
:authorize-uri | *oauth/authorize* |
:access-token-uri | *oauth/access-token* |
Class representing a dialogue entry in a chat-post.
label.
name.
phrase.
print-object.
Class representing a link post.
Class representing a photo in a photo/set post.
:caption
Class representing a photo/set post.
In order to change or upload photos, please use the FILE slot. Acceptable are a single string (representing the URL to a photo), a pathname, an octet vector or a list of pathnames or octet vectors.
post.
caption.
(setf caption).
caption.
(setf file).
file.
height.
height.
photos.
(setf photos).
photos.
save.
width.
width.
:photos
:caption
Class representing a photo-size of a photo.
height.
print-object.
url.
width.
Superclass for posts. Should not be used directly.
Every type of post has a lot of fields in common with every other, this class defines these common fields. Note that some fields, such as TWEET, SLUG and POST-FORMAT are only used for creating or editing posts and are never actually returned by the API.
album.
album-art.
answer.
artist.
askin-name.
asking-url.
augment.
blog-name.
blog-name.
body.
bookmarklet.
bookmarklet.
caption.
date.
(setf date).
date.
description.
destroy.
dialogue.
file.
height.
id.
id.
like.
liked.
liked.
mobile.
mobile.
note-count.
photos.
play-count.
player.
players.
post.
post-format.
(setf post-format).
post-format.
post-type.
post-type.
post-url.
post-url.
post=.
post=.
post=.
print-object.
question.
reblog.
reblog-key.
reblog-key.
reblog-p.
refresh.
repost.
repost.
short-url.
slug.
(setf slug).
slug.
source.
source-title.
source-title.
source-url.
source-url.
state.
(setf state).
state.
summary.
tags.
(setf tags).
tags.
text-format.
(setf text-format).
text-format.
timestamp.
timestamp.
title.
track-name.
track-number.
trail.
tweet.
(setf tweet).
tweet.
unlike.
url.
width.
year.
:text-format
:reblog-key
This slot is read-only.
:bookmarklet
This slot is read-only.
:source-url
This slot is read-only.
:source-title
This slot is read-only.
:state
:note-count
This slot is read-only.
:post-format
:tweet
Class representing a quote post.
Class representing a text post.
Class representing a user.
Every user is also a blog. See the BLOG class.
Class representing a video player object in a video-post.
:embed-code
This slot is read-only.
Class representing a video post.
In order to change or upload video files, please use the FILE slot. Acceptable are a string (being the HTML embedding code for the video), a pathname or an octet vector. The file format has to be MP4 with audio encoded in AAC.
Same as REQUEST, except using RAW-DATA-REQUEST in the back.
Same as RAW-REQUEST, except uses a signed data payload request.
| Jump to: | %
(
*
A B C D E F G H I K L M N P Q R S T U V W Y |
|---|
| Jump to: | %
(
*
A B C D E F G H I K L M N P Q R S T U V W Y |
|---|
| Jump to: | *
A B C D E F H I L M N P Q R S T U W Y |
|---|
| Jump to: | *
A B C D E F H I L M N P Q R S T U W Y |
|---|
| Jump to: | A B C D F G H L O P Q S T U V |
|---|
| Jump to: | A B C D F G H L O P Q S T U V |
|---|