This is the tooter Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:54:22 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
tooter
A client library for Mastodon instances.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
zlib
1.0.0
alexandria
(system).
yason
(system).
cl-ppcre
(system).
drakma
(system).
documentation-utils
(system).
package.lisp
(file).
toolkit.lisp
(file).
link-header-parser.lisp
(file).
client.lisp
(file).
objects.lisp
(file).
queries.lisp
(file).
documentation.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
tooter/tooter.asd
tooter/package.lisp
tooter/toolkit.lisp
tooter/link-header-parser.lisp
tooter/client.lisp
tooter/objects.lisp
tooter/queries.lisp
tooter/documentation.lisp
tooter/toolkit.lisp
package.lisp
(file).
tooter
(system).
coerce-boolean
(function).
convert-timestamp
(function).
ensure-integer
(generic function).
plain-format-html
(function).
to-keyword
(function).
universal->utc-timestring
(function).
%getj
(function).
*html-escape-table*
(special variable).
*unix-epoch-difference*
(special variable).
getj
(compiler macro).
getj
(function).
line-wrap
(function).
make-url
(function).
param-plist->alist
(function).
parse-timestring
(function).
translate-key
(function).
universal->unix
(function).
unix->universal
(function).
url-encode
(function).
tooter/link-header-parser.lisp
toolkit.lisp
(file).
tooter
(system).
find-pagination-links
(function).
link-record-parameters
(reader).
(setf link-record-parameters)
(writer).
link-record-url
(reader).
(setf link-record-url)
(writer).
parse
(function).
+pagination-parameter-key+
(constant).
+pagination-parameter-next-page+
(constant).
+pagination-parameter-previous-page+
(constant).
+parameter-value-wrapper-char+
(constant).
+tokens+
(constant).
+url-wrapper-chars+
(constant).
consume-blanks
(function).
consume-parameter-separator
(function).
copy-link-header
(function).
copy-link-record
(function).
field-separator
(function).
find-link-header
(function).
find-link-to-next-page
(function).
find-link-to-previous-page
(function).
find-pagination-link
(function).
find-rel-links
(function).
link-header
(structure).
link-header-p
(function).
link-header-records
(reader).
(setf link-header-records)
(writer).
link-record
(function).
link-record
(structure).
link-record-p
(function).
make-link-header
(function).
make-link-record
(function).
next-token
(function).
parameters
(function).
record-separator
(function).
signal-error
(function).
token-value
(function).
token=
(function).
url
(function).
tooter/client.lisp
link-header-parser.lisp
(file).
tooter
(system).
access-token
(reader method).
(setf access-token)
(writer method).
account
(reader method).
(setf account)
(writer method).
authorize
(method).
base
(reader method).
(setf base)
(writer method).
client
(class).
code
(reader method).
data
(reader method).
default-headers
(method).
key
(reader method).
(setf key)
(writer method).
make-load-form
(method).
message
(reader method).
name
(reader method).
(setf name)
(writer method).
print-object
(method).
query
(method).
query-url
(method).
redirect
(reader method).
(setf redirect)
(writer method).
register
(method).
request
(function).
request-failed
(condition).
scopes
(reader method).
(setf scopes)
(writer method).
secret
(reader method).
(setf secret)
(writer method).
submit
(method).
uri
(reader method).
website
(reader method).
(setf website)
(writer method).
%request
(function).
request-method
(reader method).
tooter/objects.lisp
client.lisp
(file).
tooter
(system).
access-token
(reader method).
(setf access-token)
(writer method).
account
(reader method).
account
(reader method).
(setf account)
(writer method).
(setf account)
(writer method).
account
(class).
account-count
(reader method).
(setf account-count)
(writer method).
account-name
(reader method).
account-name
(reader method).
account-name
(reader method).
(setf account-name)
(writer method).
(setf account-name)
(writer method).
(setf account-name)
(writer method).
accounts
(reader method).
(setf accounts)
(writer method).
action-taken
(reader method).
(setf action-taken)
(writer method).
alert-favourite
(reader method).
(setf alert-favourite)
(writer method).
alert-follow
(reader method).
(setf alert-follow)
(writer method).
alert-mention
(reader method).
(setf alert-mention)
(writer method).
alert-poll
(reader method).
(setf alert-poll)
(writer method).
alert-reblog
(reader method).
(setf alert-reblog)
(writer method).
alerts
(reader method).
(setf alerts)
(writer method).
all-day
(reader method).
(setf all-day)
(writer method).
ancestors
(reader method).
(setf ancestors)
(writer method).
announcement
(class).
announcement-account
(class).
announcement-status
(class).
application
(reader method).
(setf application)
(writer method).
application
(class).
application-id
(reader method).
(setf application-id)
(writer method).
approval-required
(reader method).
(setf approval-required)
(writer method).
aspect
(reader method).
(setf aspect)
(writer method).
attachment
(class).
audio-bitrate
(reader method).
(setf audio-bitrate)
(writer method).
audio-channels
(reader method).
(setf audio-channels)
(writer method).
audio-encode
(reader method).
(setf audio-encode)
(writer method).
audio-length
(reader method).
(setf audio-length)
(writer method).
audio-metadata
(class).
author-name
(reader method).
(setf author-name)
(writer method).
author-url
(reader method).
(setf author-url)
(writer method).
avatar
(reader method).
(setf avatar)
(writer method).
avatar-static
(reader method).
(setf avatar-static)
(writer method).
bitrate
(reader method).
(setf bitrate)
(writer method).
blocked-by
(reader method).
(setf blocked-by)
(writer method).
blocking
(reader method).
(setf blocking)
(writer method).
blurhash
(reader method).
(setf blurhash)
(writer method).
bookmarked
(reader method).
(setf bookmarked)
(writer method).
bot
(reader method).
(setf bot)
(writer method).
card
(class).
contact-account
(reader method).
(setf contact-account)
(writer method).
content
(reader method).
content
(reader method).
(setf content)
(writer method).
(setf content)
(writer method).
context
(class).
conversation
(class).
created-at
(reader method).
created-at
(reader method).
created-at
(reader method).
created-at
(reader method).
(setf created-at)
(writer method).
(setf created-at)
(writer method).
(setf created-at)
(writer method).
(setf created-at)
(writer method).
day
(reader method).
(setf day)
(writer method).
decode-entity
(generic function).
define-entity
(macro).
descendants
(reader method).
(setf descendants)
(writer method).
describe-object
(method).
description
(reader method).
description
(reader method).
description
(reader method).
(setf description)
(writer method).
(setf description)
(writer method).
(setf description)
(writer method).
discoverable
(reader method).
(setf discoverable)
(writer method).
display-name
(reader method).
(setf display-name)
(writer method).
domain-blocking
(reader method).
(setf domain-blocking)
(writer method).
domain-count
(reader method).
(setf domain-count)
(writer method).
duration
(reader method).
duration
(reader method).
(setf duration)
(writer method).
(setf duration)
(writer method).
email
(reader method).
(setf email)
(writer method).
embed-url
(reader method).
(setf embed-url)
(writer method).
emoji
(class).
emojis
(reader method).
emojis
(reader method).
emojis
(reader method).
emojis
(reader method).
(setf emojis)
(writer method).
(setf emojis)
(writer method).
(setf emojis)
(writer method).
(setf emojis)
(writer method).
endorsed
(reader method).
(setf endorsed)
(writer method).
endpoint
(reader method).
(setf endpoint)
(writer method).
ends-at
(reader method).
(setf ends-at)
(writer method).
entity
(class).
expired
(reader method).
(setf expired)
(writer method).
expires-at
(reader method).
expires-at
(reader method).
(setf expires-at)
(writer method).
(setf expires-at)
(writer method).
favourited
(reader method).
(setf favourited)
(writer method).
favourites-count
(reader method).
(setf favourites-count)
(writer method).
featured-tag
(class).
fields
(reader method).
fields
(reader method).
(setf fields)
(writer method).
(setf fields)
(writer method).
filter
(class).
filter-keyword
(class).
filter-status
(class).
focus
(reader method).
(setf focus)
(writer method).
follow-requests-count
(reader method).
(setf follow-requests-count)
(writer method).
followed-by
(reader method).
(setf followed-by)
(writer method).
followers-count
(reader method).
(setf followers-count)
(writer method).
following
(reader method).
following
(reader method).
(setf following)
(writer method).
(setf following)
(writer method).
following-count
(reader method).
(setf following-count)
(writer method).
frame-rate
(reader method).
(setf frame-rate)
(writer method).
header
(reader method).
(setf header)
(writer method).
header-static
(reader method).
(setf header-static)
(writer method).
height
(reader method).
height
(reader method).
height
(reader method).
(setf height)
(writer method).
(setf height)
(writer method).
(setf height)
(writer method).
history
(reader method).
(setf history)
(writer method).
html
(reader method).
(setf html)
(writer method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
id
(reader method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
(setf id)
(writer method).
identity-proof
(class).
image
(reader method).
(setf image)
(writer method).
image-metadata
(class).
in-reply-to-account-id
(reader method).
(setf in-reply-to-account-id)
(writer method).
in-reply-to-id
(reader method).
in-reply-to-id
(reader method).
(setf in-reply-to-id)
(writer method).
(setf in-reply-to-id)
(writer method).
instance
(class).
instance-stats
(class).
keyword-matches
(reader method).
(setf keyword-matches)
(writer method).
kind
(reader method).
kind
(reader method).
kind
(reader method).
(setf kind)
(writer method).
(setf kind)
(writer method).
(setf kind)
(writer method).
language
(reader method).
language
(reader method).
(setf language)
(writer method).
(setf language)
(writer method).
languages
(reader method).
(setf languages)
(writer method).
last-read-id
(reader method).
(setf last-read-id)
(writer method).
last-status
(reader method).
(setf last-status)
(writer method).
last-status-at
(reader method).
(setf last-status-at)
(writer method).
locked
(reader method).
(setf locked)
(writer method).
marker
(class).
me
(reader method).
(setf me)
(writer method).
media-attachments
(reader method).
(setf media-attachments)
(writer method).
media-ids
(reader method).
(setf media-ids)
(writer method).
mention
(class).
mentions
(reader method).
mentions
(reader method).
(setf mentions)
(writer method).
(setf mentions)
(writer method).
metadata
(reader method).
(setf metadata)
(writer method).
metadata
(class).
moved
(reader method).
(setf moved)
(writer method).
multiple
(reader method).
(setf multiple)
(writer method).
muted
(reader method).
(setf muted)
(writer method).
muting
(reader method).
(setf muting)
(writer method).
muting-notifications
(reader method).
(setf muting-notifications)
(writer method).
name
(reader method).
name
(reader method).
name
(reader method).
name
(reader method).
name
(reader method).
name
(reader method).
(setf name)
(writer method).
(setf name)
(writer method).
(setf name)
(writer method).
(setf name)
(writer method).
(setf name)
(writer method).
(setf name)
(writer method).
note
(reader method).
note
(reader method).
(setf note)
(writer method).
(setf note)
(writer method).
notification
(class).
options
(reader method).
(setf options)
(writer method).
original
(reader method).
(setf original)
(writer method).
own-votes
(reader method).
(setf own-votes)
(writer method).
params
(reader method).
(setf params)
(writer method).
parent
(reader method).
(setf parent)
(writer method).
pinned
(reader method).
(setf pinned)
(writer method).
poll
(reader method).
(setf poll)
(writer method).
poll
(class).
poll-option
(class).
posting-default-language
(reader method).
(setf posting-default-language)
(writer method).
posting-default-sensitive
(reader method).
(setf posting-default-sensitive)
(writer method).
posting-default-visibility
(reader method).
(setf posting-default-visibility)
(writer method).
preferences
(class).
preview-card
(reader method).
(setf preview-card)
(writer method).
preview-url
(reader method).
(setf preview-url)
(writer method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
print-object
(method).
privacy
(reader method).
(setf privacy)
(writer method).
profile-url
(reader method).
(setf profile-url)
(writer method).
proof-url
(reader method).
(setf proof-url)
(writer method).
provider
(reader method).
(setf provider)
(writer method).
provider-name
(reader method).
(setf provider-name)
(writer method).
provider-url
(reader method).
(setf provider-url)
(writer method).
provider-username
(reader method).
(setf provider-username)
(writer method).
published
(reader method).
(setf published)
(writer method).
published-at
(reader method).
(setf published-at)
(writer method).
push-subscription
(class).
push-subscription-alerts
(class).
query-filter
(reader method).
(setf query-filter)
(writer method).
reaction
(class).
reaction-count
(reader method).
(setf reaction-count)
(writer method).
reactions
(reader method).
(setf reactions)
(writer method).
reading-expand-media
(reader method).
(setf reading-expand-media)
(writer method).
reading-expand-spoilers
(reader method).
(setf reading-expand-spoilers)
(writer method).
readp
(reader method).
(setf readp)
(writer method).
reblogged
(reader method).
(setf reblogged)
(writer method).
reblogs-count
(reader method).
(setf reblogs-count)
(writer method).
registrations
(reader method).
registrations
(reader method).
(setf registrations)
(writer method).
(setf registrations)
(writer method).
relationship
(class).
remote-url
(reader method).
(setf remote-url)
(writer method).
replies-count
(reader method).
(setf replies-count)
(writer method).
report
(class).
requested
(reader method).
(setf requested)
(writer method).
results
(class).
results-accounts
(reader method).
(setf results-accounts)
(writer method).
results-statuses
(reader method).
(setf results-statuses)
(writer method).
results-tags
(reader method).
(setf results-tags)
(writer method).
scheduled-at
(reader method).
scheduled-at
(reader method).
(setf scheduled-at)
(writer method).
(setf scheduled-at)
(writer method).
scheduled-status
(class).
scope
(reader method).
(setf scope)
(writer method).
sensitive
(reader method).
sensitive
(reader method).
sensitive
(reader method).
(setf sensitive)
(writer method).
(setf sensitive)
(writer method).
(setf sensitive)
(writer method).
server-key
(reader method).
(setf server-key)
(writer method).
short-description
(reader method).
(setf short-description)
(writer method).
shortcode
(reader method).
(setf shortcode)
(writer method).
showing-reblogs
(reader method).
(setf showing-reblogs)
(writer method).
size
(reader method).
(setf size)
(writer method).
small
(reader method).
(setf small)
(writer method).
source
(reader method).
(setf source)
(writer method).
source
(class).
spoiler-text
(reader method).
spoiler-text
(reader method).
(setf spoiler-text)
(writer method).
(setf spoiler-text)
(writer method).
starts-at
(reader method).
(setf starts-at)
(writer method).
static-url
(reader method).
static-url
(reader method).
(setf static-url)
(writer method).
(setf static-url)
(writer method).
stats
(reader method).
(setf stats)
(writer method).
status
(reader method).
(setf status)
(writer method).
status
(class).
status-count
(reader method).
(setf status-count)
(writer method).
status-id
(reader method).
status-id
(reader method).
(setf status-id)
(writer method).
(setf status-id)
(writer method).
status-matches
(reader method).
(setf status-matches)
(writer method).
status-params
(class).
status-tag
(class).
statuses
(reader method).
statuses
(reader method).
statuses
(reader method).
(setf statuses)
(writer method).
(setf statuses)
(writer method).
(setf statuses)
(writer method).
statuses-count
(reader method).
statuses-count
(reader method).
(setf statuses-count)
(writer method).
(setf statuses-count)
(writer method).
tag
(class).
tag-history
(class).
tags
(reader method).
tags
(reader method).
(setf tags)
(writer method).
(setf tags)
(writer method).
text
(reader method).
(setf text)
(writer method).
text-url
(reader method).
(setf text-url)
(writer method).
thumbnail
(reader method).
(setf thumbnail)
(writer method).
title
(reader method).
title
(reader method).
title
(reader method).
title
(reader method).
title
(reader method).
(setf title)
(writer method).
(setf title)
(writer method).
(setf title)
(writer method).
(setf title)
(writer method).
(setf title)
(writer method).
token
(class).
token-type
(reader method).
(setf token-type)
(writer method).
unread
(reader method).
(setf unread)
(writer method).
updated-at
(reader method).
updated-at
(reader method).
updated-at
(reader method).
(setf updated-at)
(writer method).
(setf updated-at)
(writer method).
(setf updated-at)
(writer method).
uri
(reader method).
uri
(reader method).
(setf uri)
(writer method).
(setf uri)
(writer method).
url
(reader method).
url
(reader method).
url
(reader method).
url
(reader method).
url
(reader method).
url
(reader method).
url
(reader method).
url
(reader method).
url
(reader method).
url
(reader method).
url
(reader method).
(setf url)
(writer method).
(setf url)
(writer method).
(setf url)
(writer method).
(setf url)
(writer method).
(setf url)
(writer method).
(setf url)
(writer method).
(setf url)
(writer method).
(setf url)
(writer method).
(setf url)
(writer method).
(setf url)
(writer method).
(setf url)
(writer method).
urls
(reader method).
(setf urls)
(writer method).
use-count
(reader method).
(setf use-count)
(writer method).
user-count
(reader method).
(setf user-count)
(writer method).
user-list
(class).
username
(reader method).
username
(reader method).
username
(reader method).
(setf username)
(writer method).
(setf username)
(writer method).
(setf username)
(writer method).
vapid-key
(reader method).
(setf vapid-key)
(writer method).
version
(reader method).
version
(reader method).
(setf version)
(writer method).
(setf version)
(writer method).
video-metadata
(class).
visibility
(reader method).
visibility
(reader method).
(setf visibility)
(writer method).
(setf visibility)
(writer method).
visible-in-picker
(reader method).
(setf visible-in-picker)
(writer method).
voted
(reader method).
(setf voted)
(writer method).
voters-count
(reader method).
(setf voters-count)
(writer method).
votes-count
(reader method).
votes-count
(reader method).
(setf votes-count)
(writer method).
(setf votes-count)
(writer method).
website
(reader method).
(setf website)
(writer method).
whole-word
(reader method).
(setf whole-word)
(writer method).
width
(reader method).
width
(reader method).
width
(reader method).
(setf width)
(writer method).
(setf width)
(writer method).
(setf width)
(writer method).
%decode-metadata
(function).
*translator*
(special variable).
activity
(class).
category
(reader method).
(setf category)
(writer method).
decode-account
(function).
decode-activity
(function).
decode-announcement
(function).
decode-announcement-account
(function).
decode-announcement-status
(function).
decode-application
(function).
decode-attachment
(function).
decode-audio-metadata
(function).
decode-card
(function).
decode-context
(function).
decode-conversation
(function).
decode-emoji
(function).
decode-featured-tag
(function).
decode-field
(function).
decode-filter
(function).
decode-filter-keyword
(function).
decode-filter-results
(function).
decode-filter-status
(function).
decode-identity-proof
(function).
decode-image-metadata
(function).
decode-instance
(function).
decode-instance-stats
(function).
decode-marker
(function).
decode-mention
(function).
decode-metadata
(function).
decode-notification
(function).
decode-poll
(function).
decode-poll-option
(function).
decode-preferences
(function).
decode-push-subscription
(function).
decode-push-subscription-alerts
(function).
decode-reaction
(function).
decode-relationship
(function).
decode-report
(function).
decode-results
(function).
decode-scheduled-status
(function).
decode-source
(function).
decode-status
(function).
decode-status-params
(function).
decode-status-tag
(function).
decode-tag
(function).
decode-tag-history
(function).
decode-token
(function).
decode-user-list
(function).
decode-video-metadata
(function).
field
(class).
filter-action
(reader method).
(setf filter-action)
(writer method).
filter-context
(reader method).
(setf filter-context)
(writer method).
filter-results
(class).
filtered
(reader method).
(setf filtered)
(writer method).
keywords
(reader method).
(setf keywords)
(writer method).
logins
(reader method).
(setf logins)
(writer method).
present
(method).
translate-languages
(function).
value
(reader method).
(setf value)
(writer method).
verified-at
(reader method).
(setf verified-at)
(writer method).
week
(reader method).
(setf week)
(writer method).
tooter/queries.lisp
objects.lisp
(file).
tooter
(system).
accept-request
(method).
accept-request
(method).
account-directory
(method).
add-filter-keyword
(method).
add-reaction-announcement
(method).
add-user-list-accounts
(method).
add-user-list-accounts
(method).
block
(method).
block
(method).
blocked-domains
(method).
blocks
(method).
bookmark
(method).
bookmark
(method).
bookmarks
(method).
card
(method).
card
(method).
collect-all-pages
(macro).
context
(method).
context
(method).
conversations
(generic function).
create-filter
(method).
delete-conversation
(method).
delete-filter
(method).
delete-notification
(method).
delete-notification
(method).
delete-notification
(method).
delete-status
(method).
delete-status
(method).
delete-subscription
(method).
delete-user-list
(method).
dismiss-announcement
(method).
dismiss-reaction-announcement
(method).
do-pages
(macro).
edit-status
(method).
edit-status
(method).
emojis
(method).
endorsements
(method).
favourite
(method).
favourite
(method).
favouriters
(method).
favouriters
(method).
favourites
(method).
filter
(method).
filter
(method).
filter-keywords
(method).
filters
(method).
find-account
(method).
find-filter
(method).
find-list
(method).
find-notification
(method).
find-results
(method).
find-status
(method).
follow
(method).
follow
(method).
follow-requests
(method).
follow-tag
(generic function).
followed-tags
(generic function).
get-activity
(method).
get-announcements
(method).
get-followers
(method).
get-followers
(method).
get-followers
(method).
get-following
(method).
get-following
(method).
get-following
(method).
get-statuses
(method).
get-statuses
(method).
get-statuses
(method).
identity-proof
(method).
instance
(method).
make-media
(method).
make-report
(method).
make-report
(method).
make-status
(method).
make-subscription
(method).
make-update-filter-field
(function).
make-user-list
(method).
mark-read-conversation
(method).
markers
(method).
mute
(method).
mute
(method).
mute
(method).
mute-conversation
(method).
mute-conversation
(method).
mutes
(method).
navigate-page
(function).
notifications
(method).
peers
(method).
pin
(method).
pin
(method).
poll-vote
(method).
poll-vote
(method).
polls
(method).
polls
(method).
preferences
(method).
reblog
(method).
reblog
(method).
rebloggers
(method).
rebloggers
(method).
reject-request
(method).
reject-request
(method).
relationships
(method).
relationships
(method).
remove-filter-keyword
(method).
remove-user-list-accounts
(method).
remove-user-list-accounts
(method).
reports
(method).
save-markers
(method).
search-accounts
(method).
subscription
(method).
tag-information
(generic function).
timeline
(generic function).
timeline-tag
(generic function).
trends
(method).
unblock
(method).
unblock
(method).
unbookmark
(method).
unbookmark
(method).
unfavourite
(method).
unfavourite
(method).
unfollow
(method).
unfollow
(method).
unfollow-tag
(generic function).
unmute
(method).
unmute
(method).
unmute
(method).
unmute-conversation
(method).
unmute-conversation
(method).
unpin
(method).
unpin
(method).
unreblog
(method).
unreblog
(method).
update-credentials
(method).
update-filter
(method).
update-media
(method).
update-media
(method).
update-user-list
(method).
update-user-list
(method).
user-list-accounts
(method).
user-list-accounts
(method).
(setf user-list-accounts)
(method).
user-lists
(method).
user-lists
(method).
user-lists
(method).
verify-app-credentials
(method).
verify-credentials
(method).
weekly-activity
(method).
%timeline
(function).
check-filter-action
(function).
check-filter-context
(function).
check-list-replies-policy-to-values
(function).
encode-filter-context
(function).
encode-notification-type
(function).
make-pagination-handle
(function).
oembed
(method).
pagination-decoding-function
(function).
pagination-url
(function).
status-ensure-language
(function).
status-ensure-media-id
(method).
status-ensure-media-id
(method).
status-ensure-media-id
(method).
status-ensure-media-id
(method).
status-ensure-media-id
(method).
status-ensure-media-id
(method).
with-pagination-return
(macro).
tooter/documentation.lisp
queries.lisp
(file).
tooter
(system).
Packages are listed by definition order.
tooter-queries
org.shirakumo.tooter.queries
accept-request
(generic function).
account-directory
(generic function).
add-filter-keyword
(generic function).
add-reaction-announcement
(generic function).
add-user-list-accounts
(generic function).
block
(generic function).
blocked-domains
(generic function).
blocks
(generic function).
bookmark
(generic function).
bookmarks
(generic function).
collect-all-pages
(macro).
conversation
(class).
create-filter
(generic function).
delete-conversation
(generic function).
delete-filter
(generic function).
delete-notification
(generic function).
delete-status
(generic function).
delete-subscription
(generic function).
delete-user-list
(generic function).
dismiss-announcement
(generic function).
dismiss-reaction-announcement
(generic function).
do-pages
(macro).
edit-status
(generic function).
endorsements
(generic function).
favourite
(generic function).
favouriters
(generic function).
favourites
(generic function).
filter-keywords
(generic function).
filters
(generic function).
find-account
(generic function).
find-filter
(generic function).
find-list
(generic function).
find-notification
(generic function).
find-results
(generic function).
find-status
(generic function).
follow
(generic function).
follow-requests
(generic function).
follow-tag
(generic function).
followed-tags
(generic function).
get-activity
(generic function).
get-announcements
(generic function).
get-followers
(generic function).
get-following
(generic function).
get-statuses
(generic function).
make-media
(generic function).
make-report
(generic function).
make-status
(generic function).
make-subscription
(generic function).
make-update-filter-field
(function).
make-user-list
(generic function).
mark-read-conversation
(generic function).
markers
(generic function).
mute
(generic function).
mute-conversation
(generic function).
mutes
(generic function).
navigate-page
(function).
notifications
(generic function).
peers
(generic function).
pin
(generic function).
poll-vote
(generic function).
polls
(generic function).
reblog
(generic function).
rebloggers
(generic function).
reject-request
(generic function).
relationships
(generic function).
remove-filter-keyword
(generic function).
remove-user-list-accounts
(generic function).
reports
(generic function).
save-markers
(generic function).
search-accounts
(generic function).
subscription
(generic function).
tag-information
(generic function).
timeline
(generic function).
timeline-tag
(generic function).
trends
(generic function).
unblock
(generic function).
unbookmark
(generic function).
unfavourite
(generic function).
unfollow
(generic function).
unfollow-tag
(generic function).
unmute
(generic function).
unmute-conversation
(generic function).
unpin
(generic function).
unreblog
(generic function).
update-credentials
(generic function).
update-filter
(generic function).
update-media
(generic function).
update-user-list
(generic function).
user-list-accounts
(generic function).
(setf user-list-accounts)
(generic function).
user-lists
(generic function).
verify-app-credentials
(generic function).
verify-credentials
(generic function).
weekly-activity
(generic function).
tooter-client
org.shirakumo.tooter.client
authorize
(generic function).
base
(generic reader).
(setf base)
(generic writer).
client
(class).
code
(generic reader).
coerce-boolean
(function).
convert-timestamp
(function).
data
(generic reader).
default-headers
(generic function).
ensure-integer
(generic function).
key
(generic reader).
(setf key)
(generic writer).
message
(generic reader).
plain-format-html
(function).
query
(generic function).
query-url
(generic function).
redirect
(generic reader).
(setf redirect)
(generic writer).
register
(generic function).
request
(function).
request-failed
(condition).
scopes
(generic reader).
(setf scopes)
(generic writer).
secret
(generic reader).
(setf secret)
(generic writer).
submit
(generic function).
to-keyword
(function).
universal->utc-timestring
(function).
tooter-link-header-parser
common-lisp
.
find-pagination-links
(function).
link-record-parameters
(reader).
(setf link-record-parameters)
(writer).
link-record-url
(reader).
(setf link-record-url)
(writer).
parse
(function).
+pagination-parameter-key+
(constant).
+pagination-parameter-next-page+
(constant).
+pagination-parameter-previous-page+
(constant).
+parameter-value-wrapper-char+
(constant).
+tokens+
(constant).
+url-wrapper-chars+
(constant).
consume-blanks
(function).
consume-parameter-separator
(function).
copy-link-header
(function).
copy-link-record
(function).
field-separator
(function).
find-link-header
(function).
find-link-to-next-page
(function).
find-link-to-previous-page
(function).
find-pagination-link
(function).
find-rel-links
(function).
link-header
(structure).
link-header-p
(function).
link-header-records
(reader).
(setf link-header-records)
(writer).
link-record
(function).
link-record
(structure).
link-record-p
(function).
make-link-header
(function).
make-link-record
(function).
next-token
(function).
parameters
(function).
record-separator
(function).
signal-error
(function).
token-value
(function).
token=
(function).
url
(function).
tooter-objects
org.shirakumo.tooter.objects
access-token
(slot).
access-token
(generic reader).
(setf access-token)
(generic writer).
account
(slot).
account
(generic reader).
(setf account)
(generic writer).
account
(class).
account-count
(generic reader).
(setf account-count)
(generic writer).
account-name
(generic reader).
(setf account-name)
(generic writer).
accounts
(slot).
accounts
(generic reader).
(setf accounts)
(generic writer).
action-taken
(generic reader).
(setf action-taken)
(generic writer).
alert-favourite
(generic reader).
(setf alert-favourite)
(generic writer).
alert-follow
(generic reader).
(setf alert-follow)
(generic writer).
alert-mention
(generic reader).
(setf alert-mention)
(generic writer).
alert-poll
(generic reader).
(setf alert-poll)
(generic writer).
alert-reblog
(generic reader).
(setf alert-reblog)
(generic writer).
alerts
(generic reader).
(setf alerts)
(generic writer).
all-day
(generic reader).
(setf all-day)
(generic writer).
ancestors
(generic reader).
(setf ancestors)
(generic writer).
announcement
(class).
announcement-account
(class).
announcement-status
(class).
application
(generic reader).
(setf application)
(generic writer).
application
(class).
application-id
(generic reader).
(setf application-id)
(generic writer).
approval-required
(generic reader).
(setf approval-required)
(generic writer).
aspect
(generic reader).
(setf aspect)
(generic writer).
attachment
(class).
audio-bitrate
(generic reader).
(setf audio-bitrate)
(generic writer).
audio-channels
(generic reader).
(setf audio-channels)
(generic writer).
audio-encode
(generic reader).
(setf audio-encode)
(generic writer).
audio-length
(generic reader).
(setf audio-length)
(generic writer).
audio-metadata
(class).
author-name
(generic reader).
(setf author-name)
(generic writer).
author-url
(generic reader).
(setf author-url)
(generic writer).
avatar
(generic reader).
(setf avatar)
(generic writer).
avatar-static
(generic reader).
(setf avatar-static)
(generic writer).
bitrate
(generic reader).
(setf bitrate)
(generic writer).
blocked-by
(generic reader).
(setf blocked-by)
(generic writer).
blocking
(generic reader).
(setf blocking)
(generic writer).
blurhash
(generic reader).
(setf blurhash)
(generic writer).
bookmarked
(generic reader).
(setf bookmarked)
(generic writer).
bot
(generic reader).
(setf bot)
(generic writer).
card
(generic function).
card
(class).
contact-account
(generic reader).
(setf contact-account)
(generic writer).
content
(generic reader).
(setf content)
(generic writer).
context
(generic function).
context
(class).
conversations
(generic function).
created-at
(generic reader).
(setf created-at)
(generic writer).
day
(generic reader).
(setf day)
(generic writer).
decode-entity
(generic function).
define-entity
(macro).
descendants
(generic reader).
(setf descendants)
(generic writer).
description
(generic reader).
(setf description)
(generic writer).
discoverable
(generic reader).
(setf discoverable)
(generic writer).
display-name
(generic reader).
(setf display-name)
(generic writer).
domain-blocking
(generic reader).
(setf domain-blocking)
(generic writer).
domain-count
(generic reader).
(setf domain-count)
(generic writer).
duration
(generic reader).
(setf duration)
(generic writer).
email
(generic reader).
(setf email)
(generic writer).
embed-url
(generic reader).
(setf embed-url)
(generic writer).
emoji
(class).
emojis
(generic function).
(setf emojis)
(generic writer).
endorsed
(generic reader).
(setf endorsed)
(generic writer).
endpoint
(generic reader).
(setf endpoint)
(generic writer).
ends-at
(generic reader).
(setf ends-at)
(generic writer).
entity
(class).
expired
(generic reader).
(setf expired)
(generic writer).
expires-at
(generic reader).
(setf expires-at)
(generic writer).
favourited
(generic reader).
(setf favourited)
(generic writer).
favourites-count
(generic reader).
(setf favourites-count)
(generic writer).
featured-tag
(class).
fields
(generic reader).
(setf fields)
(generic writer).
filter
(generic function).
filter
(class).
filter-keyword
(class).
filter-status
(class).
focus
(generic reader).
(setf focus)
(generic writer).
follow-requests-count
(generic reader).
(setf follow-requests-count)
(generic writer).
followed-by
(generic reader).
(setf followed-by)
(generic writer).
followers-count
(generic reader).
(setf followers-count)
(generic writer).
following
(generic reader).
(setf following)
(generic writer).
following-count
(generic reader).
(setf following-count)
(generic writer).
frame-rate
(generic reader).
(setf frame-rate)
(generic writer).
header
(generic reader).
(setf header)
(generic writer).
header-static
(generic reader).
(setf header-static)
(generic writer).
height
(generic reader).
(setf height)
(generic writer).
history
(generic reader).
(setf history)
(generic writer).
html
(generic reader).
(setf html)
(generic writer).
id
(slot).
id
(generic reader).
(setf id)
(generic writer).
identity-proof
(generic function).
identity-proof
(class).
image
(generic reader).
(setf image)
(generic writer).
image-metadata
(class).
in-reply-to-account-id
(generic reader).
(setf in-reply-to-account-id)
(generic writer).
in-reply-to-id
(generic reader).
(setf in-reply-to-id)
(generic writer).
instance
(generic function).
instance
(class).
instance-stats
(class).
keyword-matches
(generic reader).
(setf keyword-matches)
(generic writer).
keyword-matches
(slot).
kind
(generic reader).
(setf kind)
(generic writer).
language
(generic reader).
(setf language)
(generic writer).
languages
(generic reader).
(setf languages)
(generic writer).
last-read-id
(generic reader).
(setf last-read-id)
(generic writer).
last-status
(slot).
last-status
(generic reader).
(setf last-status)
(generic writer).
last-status-at
(generic reader).
(setf last-status-at)
(generic writer).
locked
(generic reader).
(setf locked)
(generic writer).
marker
(class).
me
(generic reader).
(setf me)
(generic writer).
media-attachments
(generic reader).
(setf media-attachments)
(generic writer).
media-ids
(generic reader).
(setf media-ids)
(generic writer).
mention
(class).
mentions
(generic reader).
(setf mentions)
(generic writer).
metadata
(generic reader).
(setf metadata)
(generic writer).
metadata
(class).
moved
(generic reader).
(setf moved)
(generic writer).
multiple
(generic reader).
(setf multiple)
(generic writer).
muted
(generic reader).
(setf muted)
(generic writer).
muting
(generic reader).
(setf muting)
(generic writer).
muting-notifications
(generic reader).
(setf muting-notifications)
(generic writer).
name
(slot).
name
(generic reader).
(setf name)
(generic writer).
name
(slot).
note
(generic reader).
(setf note)
(generic writer).
notification
(class).
options
(generic reader).
(setf options)
(generic writer).
original
(generic reader).
(setf original)
(generic writer).
own-votes
(generic reader).
(setf own-votes)
(generic writer).
params
(generic reader).
(setf params)
(generic writer).
parent
(generic reader).
(setf parent)
(generic writer).
pinned
(generic reader).
(setf pinned)
(generic writer).
poll
(generic reader).
(setf poll)
(generic writer).
poll
(class).
poll-option
(class).
posting-default-language
(generic reader).
(setf posting-default-language)
(generic writer).
posting-default-sensitive
(generic reader).
(setf posting-default-sensitive)
(generic writer).
posting-default-visibility
(generic reader).
(setf posting-default-visibility)
(generic writer).
preferences
(generic function).
preferences
(class).
preview-card
(generic reader).
(setf preview-card)
(generic writer).
preview-url
(generic reader).
(setf preview-url)
(generic writer).
privacy
(generic reader).
(setf privacy)
(generic writer).
profile-url
(generic reader).
(setf profile-url)
(generic writer).
proof-url
(generic reader).
(setf proof-url)
(generic writer).
provider
(generic reader).
(setf provider)
(generic writer).
provider-name
(generic reader).
(setf provider-name)
(generic writer).
provider-url
(generic reader).
(setf provider-url)
(generic writer).
provider-username
(generic reader).
(setf provider-username)
(generic writer).
published
(generic reader).
(setf published)
(generic writer).
published-at
(generic reader).
(setf published-at)
(generic writer).
push-subscription
(class).
push-subscription-alerts
(class).
query-filter
(generic reader).
(setf query-filter)
(generic writer).
query-filter
(slot).
reaction
(class).
reaction-count
(generic reader).
(setf reaction-count)
(generic writer).
reactions
(generic reader).
(setf reactions)
(generic writer).
reading-expand-media
(generic reader).
(setf reading-expand-media)
(generic writer).
reading-expand-spoilers
(generic reader).
(setf reading-expand-spoilers)
(generic writer).
readp
(generic reader).
(setf readp)
(generic writer).
reblogged
(generic reader).
(setf reblogged)
(generic writer).
reblogs-count
(generic reader).
(setf reblogs-count)
(generic writer).
registrations
(generic reader).
(setf registrations)
(generic writer).
registrations
(slot).
relationship
(class).
remote-url
(generic reader).
(setf remote-url)
(generic writer).
replies-count
(generic reader).
(setf replies-count)
(generic writer).
report
(class).
requested
(generic reader).
(setf requested)
(generic writer).
results
(class).
results-accounts
(generic reader).
(setf results-accounts)
(generic writer).
results-statuses
(generic reader).
(setf results-statuses)
(generic writer).
results-tags
(generic reader).
(setf results-tags)
(generic writer).
scheduled-at
(generic reader).
(setf scheduled-at)
(generic writer).
scheduled-status
(class).
scope
(generic reader).
(setf scope)
(generic writer).
sensitive
(generic reader).
(setf sensitive)
(generic writer).
server-key
(generic reader).
(setf server-key)
(generic writer).
short-description
(generic reader).
(setf short-description)
(generic writer).
shortcode
(generic reader).
(setf shortcode)
(generic writer).
showing-reblogs
(generic reader).
(setf showing-reblogs)
(generic writer).
size
(generic reader).
(setf size)
(generic writer).
small
(generic reader).
(setf small)
(generic writer).
source
(generic reader).
(setf source)
(generic writer).
source
(class).
spoiler-text
(generic reader).
(setf spoiler-text)
(generic writer).
starts-at
(generic reader).
(setf starts-at)
(generic writer).
static-url
(generic reader).
(setf static-url)
(generic writer).
stats
(generic reader).
(setf stats)
(generic writer).
status
(generic reader).
(setf status)
(generic writer).
status
(class).
status-count
(generic reader).
(setf status-count)
(generic writer).
status-id
(generic reader).
(setf status-id)
(generic writer).
status-matches
(generic reader).
(setf status-matches)
(generic writer).
status-matches
(slot).
status-params
(class).
status-tag
(class).
statuses
(generic reader).
(setf statuses)
(generic writer).
statuses
(slot).
statuses-count
(generic reader).
(setf statuses-count)
(generic writer).
tag
(class).
tag-history
(class).
tags
(generic reader).
(setf tags)
(generic writer).
text
(generic reader).
(setf text)
(generic writer).
text-url
(generic reader).
(setf text-url)
(generic writer).
thumbnail
(generic reader).
(setf thumbnail)
(generic writer).
title
(generic reader).
(setf title)
(generic writer).
token
(class).
token-type
(generic reader).
(setf token-type)
(generic writer).
unread
(slot).
unread
(generic reader).
(setf unread)
(generic writer).
updated-at
(generic reader).
(setf updated-at)
(generic writer).
uri
(slot).
uri
(generic reader).
(setf uri)
(generic writer).
url
(generic reader).
(setf url)
(generic writer).
urls
(generic reader).
(setf urls)
(generic writer).
use-count
(generic reader).
(setf use-count)
(generic writer).
user-count
(generic reader).
(setf user-count)
(generic writer).
user-list
(class).
username
(generic reader).
(setf username)
(generic writer).
vapid-key
(generic reader).
(setf vapid-key)
(generic writer).
version
(generic reader).
(setf version)
(generic writer).
video-metadata
(class).
visibility
(generic reader).
(setf visibility)
(generic writer).
visible-in-picker
(generic reader).
(setf visible-in-picker)
(generic writer).
voted
(generic reader).
(setf voted)
(generic writer).
voters-count
(generic reader).
(setf voters-count)
(generic writer).
votes-count
(generic reader).
(setf votes-count)
(generic writer).
website
(slot).
website
(generic reader).
(setf website)
(generic writer).
whole-word
(generic reader).
(setf whole-word)
(generic writer).
width
(generic reader).
(setf width)
(generic writer).
tooter
org.shirakumo.tooter
common-lisp
.
tooter-client
.
tooter-objects
.
tooter-queries
.
%decode-metadata
(function).
%getj
(function).
%request
(function).
%timeline
(function).
*html-escape-table*
(special variable).
*translator*
(special variable).
*unix-epoch-difference*
(special variable).
activity
(class).
category
(slot).
category
(generic reader).
(setf category)
(generic writer).
check-filter-action
(function).
check-filter-context
(function).
check-list-replies-policy-to-values
(function).
decode-account
(function).
decode-activity
(function).
decode-announcement
(function).
decode-announcement-account
(function).
decode-announcement-status
(function).
decode-application
(function).
decode-attachment
(function).
decode-audio-metadata
(function).
decode-card
(function).
decode-context
(function).
decode-conversation
(function).
decode-emoji
(function).
decode-featured-tag
(function).
decode-field
(function).
decode-filter
(function).
decode-filter-keyword
(function).
decode-filter-results
(function).
decode-filter-status
(function).
decode-identity-proof
(function).
decode-image-metadata
(function).
decode-instance
(function).
decode-instance-stats
(function).
decode-marker
(function).
decode-mention
(function).
decode-metadata
(function).
decode-notification
(function).
decode-poll
(function).
decode-poll-option
(function).
decode-preferences
(function).
decode-push-subscription
(function).
decode-push-subscription-alerts
(function).
decode-reaction
(function).
decode-relationship
(function).
decode-report
(function).
decode-results
(function).
decode-scheduled-status
(function).
decode-source
(function).
decode-status
(function).
decode-status-params
(function).
decode-status-tag
(function).
decode-tag
(function).
decode-tag-history
(function).
decode-token
(function).
decode-user-list
(function).
decode-video-metadata
(function).
encode-filter-context
(function).
encode-notification-type
(function).
field
(class).
filter-action
(slot).
filter-action
(generic reader).
(setf filter-action)
(generic writer).
filter-context
(slot).
filter-context
(generic reader).
(setf filter-context)
(generic writer).
filter-results
(class).
filtered
(slot).
filtered
(generic reader).
(setf filtered)
(generic writer).
getj
(compiler macro).
getj
(function).
keywords
(slot).
keywords
(generic reader).
(setf keywords)
(generic writer).
line-wrap
(function).
logins
(generic reader).
(setf logins)
(generic writer).
make-pagination-handle
(function).
make-url
(function).
oembed
(generic function).
pagination-decoding-function
(function).
pagination-url
(function).
param-plist->alist
(function).
parse-timestring
(function).
present
(generic function).
request-method
(slot).
request-method
(generic reader).
status-ensure-language
(function).
status-ensure-media-id
(generic function).
translate-key
(function).
translate-languages
(function).
universal->unix
(function).
unix->universal
(function).
url-encode
(function).
value
(generic reader).
(setf value)
(generic writer).
verified-at
(generic reader).
(setf verified-at)
(generic writer).
week
(generic reader).
(setf week)
(generic writer).
with-pagination-return
(macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Some endpoints send only a "slice" (called: "page") of the complete data list. In this case the response contains an HTTP header with the URLs pointing to the next page or the previous one.
This macro will collect all the pages in a single list.
SEE do-pages
Define a mapping between a serialized JSON entity and a CLOS class
Use this macro to define a subclass of ENTITY that can be decoded by decode-entity.
The definitions of an entity is shown below:
(define-entity name slots+)
name := the name of the entity
slot := (slot-name field? nullable? translate?)
slot-name := the name of a slot of this entity, usually match a field of the JSON or another entity
field := :field field-name
field-name := a string representing the name of the field (in the JSON object) that should be mapped to the name of the entity indicated by slot-name
nullable := :nullable nullable-value
nullable-value := if non nil indicates that this field is optional in the JSON object
translate := :translate-with translation-function
translation-function := a function object to translate the field in the JSON representation to lisp
example:
(define-entity field
(name)
(value)
(verified-at :field "verified_at" :translate-with #’convert-timestamp :nullable T))
Some endpoints send only a "slice" (called: "page") of the complete data list. In this case the response contains an HTTP header with the URLs pointing to the next page or the previous one.
This macro is intended to simplify the managing of paginated data.
’do-page’ iterate on all the pages in the direction specified by the keyword parameter ’direction’ (the only values allowed fro this parameter are ’:next’ and ’:previous’, default is ’:next’), the variable: ’page’ hold the current page.
start-form must be a form that returns the data and the pagination HTTP header as multiple values; the documentation for each method will specify if the procedure returns pagination data and can be used with this macro.
For example to get all the followers:
(do-pages (client current-page :direction :next)
(get-followers client t)
(format t "~a~%" current-page))
Converts BOOLEAN to javascript representation, The argument parameter is useful when optional function argument is used like (defun (&optional (delete NIL delete-provided-p)))
Converts STAMP (an integer or string representation of a timestamp into universal timestamp format.
See UNIVERSAL->UTC-TIMESTRING
url
.
Attempts to remove all HTML tags and translate the entities into standard characters.
The exception is <br /> tags, which are turned into Linefeeds.
This function is useful for plaintext formatting of status content.
Perform a request against an API.
This is a wrapper around the underlying HTTP client, performing
automated error handling and data payload parsing.
In case the request returns with an HTTP return code other than 200,
an error of type REQUEST-FAILED is signalled.
See REQUEST-FAILED
Converts THING to a lisp keyword
Converts the output of CL:GET-UNIVERSAL-TIME to a string
representation in ISO8601 format. The string represents the time at UTC timezone.
Accept the follow request of the given account.
See ACCOUNT
See CLIENT
Returns the oauth access token.
See TOKEN
Accessor to the account the client is authorised as.
When reading, it will automatically try to fetch the account if it is not yet known. Any operation (verify-credentials, update-credentials) that returns your own user account will update this field automatically.
See CLIENT
status
)) ¶automatically generated writer method
notification
)) ¶automatically generated writer method
Returns the number of accounts that made use of the hashtag on that day.
See TAG-HISTORY
tag-history
)) ¶automatically generated reader method
tag-history
)) ¶automatically generated writer method
Returns the list of accounts in the public directory .
See CLIENT
See ACCOUNT
Returns representative name of the account.
This includes the instance’s suffix if the account resides on a remote
instance. Otherwise this is equal to the username.
See ACCOUNT
See MENTION
mention
)) ¶automatically generated reader method
announcement-account
)) ¶automatically generated reader method
mention
)) ¶automatically generated writer method
announcement-account
)) ¶automatically generated writer method
conversation
)) ¶automatically generated reader method
conversation
)) ¶automatically generated writer method
Returns what kind of action was taken in response to the report.
See REPORT
Add a keyword to a filter, if the stastus contains the keyword the filter is triggered and the action executed.
See FILTER
Add a reaction to an announcement
See ANNOUNCEMENT
The argument should be seen as follows:
ID — the ID
NAME – The name of the emoji (unicode, shortcode or URL)
Add new accounts to the user-list.
The list can be either a USER-LIST instance, or an ID of one.
The accounts in the list can be either account instances, or IDs of
accounts.
See ACCOUNT
See CLIENT
See USER-LIST
Returns if get an alert when someone favourite a status posted by the user.
See PUSH-SUBSCRIPTION-ALERTS.
push-subscription-alerts
)) ¶automatically generated reader method
push-subscription-alerts
)) ¶automatically generated writer method
Returns if get an alert when someone follows the user.
See PUSH-SUBSCRIPTION-ALERTS.
push-subscription-alerts
)) ¶automatically generated reader method
push-subscription-alerts
)) ¶automatically generated writer method
Returns if get an alert when someone mentioned the user.
See PUSH-SUBSCRIPTION-ALERTS.
push-subscription-alerts
)) ¶automatically generated reader method
push-subscription-alerts
)) ¶automatically generated writer method
Returns if get an alert when a poll the user voted or created has expired.
See POLL
See PUSH-SUBSCRIPTION-ALERTS.
push-subscription-alerts
)) ¶automatically generated reader method
push-subscription-alerts
)) ¶automatically generated writer method
Returns if get an alert when someone boosted a status posted by the user.
See PUSH-SUBSCRIPTION-ALERTS.
push-subscription-alerts
)) ¶automatically generated reader method
push-subscription-alerts
)) ¶automatically generated writer method
What kinds of alerts push notifications are being sent out for... I think.
See PUSH-SUBSCRIPTION
push-subscription
)) ¶automatically generated reader method
push-subscription
)) ¶automatically generated writer method
Returns if this announcement starts or ends on date, not daytime.
See ANNOUNCEMENT
announcement
)) ¶automatically generated reader method
announcement
)) ¶automatically generated writer method
Returns the list of ancestor status instances in the context chain.
See CONTEXT
Returns the application with which this status was made.
See STATUS
See APPLICATION
WIP
See status-params
status-params
)) ¶automatically generated reader method
status-params
)) ¶automatically generated writer method
Returns if approval from moderator is required to register to this instance.
See INSTANCE
Returns the aspect ratio of the image.
See IMAGE-METADATA
image-metadata
)) ¶automatically generated reader method
image-metadata
)) ¶automatically generated writer method
Returns the audio bitrate.
See AUDIO-METADATA
audio-metadata
)) ¶automatically generated reader method
audio-metadata
)) ¶automatically generated writer method
Returns the audio channels.
See AUDIO-METADATA
audio-metadata
)) ¶automatically generated reader method
audio-metadata
)) ¶automatically generated writer method
Returns the audio encoding (mp3, ogg etch.).
See AUDIO-METADATA
audio-metadata
)) ¶automatically generated reader method
audio-metadata
)) ¶automatically generated writer method
Returns the length (time) of the audio.
See AUDIO-METADATA
audio-metadata
)) ¶automatically generated reader method
audio-metadata
)) ¶automatically generated writer method
Returns the name of the status’ author.
See CARD
Returns the URL to the status’ author’s profile.
See CARD
Authorise the client against the Mastodon instance.
This is a two-step process that requires user-interaction. First, call this without an authorisation code. This will return NIL, and an URL as the secondary value. Instruct the user to visit this URL and to authorise the application. If you have set up a redirect, the user will automatically visit the redirect page. Otherwise, the user will be displayed a code. Instruct them to copy the code so that it can be passed to AUTHORIZE somehow. Once AUTHORIZE is called again with an authorisation code, it will attempt to obtain an access token. If successful, it will return the client and the access token. Note that by default the authorisation code is only valid for ten minutes and obtaining an access token after it has expired will result in failure.
A successful completion of the authorisation process will automatically
set the access token in the client instance.
If the client does not have the KEY and SECRET set, then this function
will automatically call out to REGISTER to obtain them.
See CLIENT
See REGISTER
Returns the full URL to the account’s avatar image.
This may be an animated image.
See ACCOUNT
Returns the full URL to the account’s static avatar image.
See ACCOUNT
Accessor to the base URL of the Mastodon instance the client connects to.
Typically this will be something like:
https://mastodon.social
https://mastodon.tymoon.eu
etc.
See CLIENT
Returns the bitrate of the video in ???.
See VIDEO-METADATA
video-metadata
)) ¶automatically generated reader method
video-metadata
)) ¶automatically generated writer method
Block a new account or domain.
The account can be either an account ID, or an ACCOUNT instance.
It can also be a string, in which case the corresponding domain is
blocked.
Returns the resulting relationship in the case of an account, or T
in the case of a domain.
See CLIENT
See ACCOUNT
See RELATIONSHIP
Returns if this user has blocking you.
See RELATIONSHIP
relationship
)) ¶automatically generated reader method
relationship
)) ¶automatically generated writer method
Retrieve a list of blocked domains.
This function returns paginated results.
See DO-PAGES
See CLIENT
Returns whether the account is blocked by you.
See RELATIONSHIP
relationship
)) ¶automatically generated reader method
relationship
)) ¶automatically generated writer method
Retrieve a list of blocked accounts.
This function returns paginated results.
See DO-PAGES
See CLIENT
See ACCOUNT
attachment
)) ¶automatically generated reader method
attachment
)) ¶automatically generated writer method
Add a STATUS to user’s bookmark.
See CLIENT
See STATUS
Returns whether this status has been bookmarked from the user.
See STATUS
Returns a list of STATUS bookmarked by the user.
This function returns paginated results.
See DO-PAGES
See CLIENT
See STATUS
Returns whether the account is a bot.
See ACCOUNT
Retrieve the card of a status.
The status can either be a STATUS instance, or an ID of one.
See STATUS
See CLIENT
See CARD
Returns the HTTP return code for the failed request.
See REQUEST-FAILED
request-failed
)) ¶code
.
Returns the account instance that represents the contact person for this instance.
See INSTANCE
Returns the status’ content as an HTML string.
See STATUS
announcement
)) ¶automatically generated reader method
status
)) ¶automatically generated writer method
announcement
)) ¶automatically generated writer method
Retrieve the context of a status.
The status can either be a STATUS instance, or an ID of one.
See CLIENT
See STATUS
See CONTEXT
Returns a list of conversation.
This function returns paginated results.
See DO-PAGES
See CONVERSATION
See CLIENT
Create a new filter.
See CLIENT
See FILTER
Returns the time when the token was created.
See TOKEN
token
)) ¶automatically generated reader method
status
)) ¶automatically generated reader method
notification
)) ¶automatically generated reader method
token
)) ¶automatically generated writer method
status
)) ¶automatically generated writer method
notification
)) ¶automatically generated writer method
Returns the data payload for the failed request as parsed JSON.
See REQUEST-FAILED
request-failed
)) ¶data
.
Returns the universal-time of the day for which this usage history is.
See TAG-HISTORY
tag-history
)) ¶automatically generated reader method
day
.
tag-history
)) ¶automatically generated writer method
day
.
Parses a data payload as the given entity type.
If the type is a symbol, a new instance of the given type is allocated and then filled in via DECODE-ENTITY. If the data is a list, a new instance is created and decoded for each entry in the list.
identity-proof
) data0) ¶filter-status
) data0) ¶filter-keyword
) data0) ¶filter-results
) data0) ¶featured-tag
) data0) ¶conversation
) data0) ¶tag-history
) data0) ¶status-tag
) data0) ¶scheduled-status
) data0) ¶status-params
) data0) ¶relationship
) data0) ¶push-subscription
) data0) ¶push-subscription-alerts
) data0) ¶preferences
) data0) ¶poll-option
) data0) ¶notification
) data0) ¶instance-stats
) data0) ¶audio-metadata
) data0) ¶video-metadata
) data0) ¶image-metadata
) data0) ¶attachment
) data0) ¶application
) data0) ¶announcement
) data0) ¶announcement-status
) data0) ¶announcement-account
) data0) ¶symbol
) (data list
)) ¶symbol
) data) ¶Returns additional headers to be sent with requests from the client.
See CLIENT
Deletes a conversation.
See CONVERSATION See CLIENT
Delete an existing filter.
See CLIENT
See FILTER
Delete or dismiss the notification.
The notification can either be a NOTIFICATION instance, an ID of one,
or T for all notifications.
Returns T.
See NOTIFICATION
See CLIENT
Delete the given status.
The status can either be a STATUS instance, or an ID of one.
Returns T.
See STATUS
See CLIENT
Delete the existing push subscription.
Returns T.
See CLIENT
Delete an existing user list.
The list can be either a USER-LIST instance, or an ID of one.
Returns T.
See USER-LIST
See CLIENT
Returns the list of descendant status instances in the context chain.
See CONTEXT
Returns the hash of the attachment as computed by blurhash algorithm. This is actually a very small preview of the attachment
See ATTACHMENT
instance
)) ¶automatically generated reader method
attachment
)) ¶automatically generated reader method
instance
)) ¶automatically generated writer method
card
)) ¶automatically generated writer method
attachment
)) ¶automatically generated writer method
Returns non nil if the status could be displayed in a public directory of the instance.
See STATUS
Get the administrator’s announcements
See ANNOUNCEMENT
The arguments should be seen as follows: ID — the announce’s ID
Dismiss a reaction to an announcement
See ANNOUNCEMENT
The argument should be seen as follows:
ID — the ID
NAME – The name of the emoji (unicode, shortcode or URL)
Returns the display name of the account.
See ACCOUNT
Returns whether you are blocking the account’s domain.
See RELATIONSHIP
relationship
)) ¶automatically generated reader method
relationship
)) ¶automatically generated writer method
Returns the count of domains this instance is federated with.
See INSTANCE-STATS
instance-stats
)) ¶automatically generated reader method
instance-stats
)) ¶automatically generated writer method
Returns the duration of the video in seconds.
See VIDEO-METADATA
audio-metadata
)) ¶automatically generated reader method
video-metadata
)) ¶automatically generated reader method
audio-metadata
)) ¶automatically generated writer method
video-metadata
)) ¶automatically generated writer method
Edit the given status.
The status can either be a STATUS instance, or an ID of one.
Returns the modified status object.
See STATUS
See CLIENT
client
) (id string
) (text string
) &key media sensitive spoiler-text language poll-options poll-expire-seconds poll-multiple poll-hide-totals) ¶Returns the primary contact email address for the instance.
See INSTANCE
photo embedding (URL)
See CARD
Retrieve a list of custom emojis present on the instance.
See CLIENT
See EMOJI
announcement
)) ¶automatically generated reader method
status
)) ¶automatically generated writer method
poll
)) ¶automatically generated writer method
announcement
)) ¶automatically generated writer method
relationship
)) ¶automatically generated reader method
relationship
)) ¶automatically generated writer method
Returns the accounts an user is showing in their profile.
See CLIENT
See PIN
See UNPIN
The endpoint URL to which push notifications are delivered.
See PUSH-SUBSCRIPTION
push-subscription
)) ¶automatically generated reader method
push-subscription
)) ¶automatically generated writer method
Returns a date when announcement will end.
See ANNOUNCEMENT
announcement
)) ¶automatically generated reader method
announcement
)) ¶automatically generated writer method
Converts OBJECT to an integer
Returns if the poll has expired
See POLL
Returns the expiration date of the filter
See FILTER
Favourite the given status.
The status can either be a STATUS instance, or an ID of one.
Returns the referenced status.
See STATUS
See CLIENT
Returns whether you have favourited this status.
See STATUS
Retrieve the list of accounts that favourited the status.
The status can either be a STATUS instance, or an ID of one.
This function returns paginated results.
See DO-PAGES
See STATUS
See CLIENT
See ACCOUNT
Retrieve a list of favourited statuses.
This function returns paginated results.
See DO-PAGES
See CLIENT
See STATUS
Returns the number of favourites this status has received.
See STATUS
Returns the user metadata.
See SOURCE
Return a filter for this user.
See CLIENT
See FILTER
Find the filter keyword using the filter ID for searching.
See CLIENT
See FILTER
Returns a list of all filters for this user.
See CLIENT
See FILTER
Find an account with the specified ID.
This only works for accounts that are local to the instance.
See CLIENT
See ACCOUNT
Find a filter using its ID for searching.
See CLIENT
See FILTER
Retrieve the user list with the given ID.
See USER-LIST
See CLIENT
Retrieve the notification of the given ID.
See NOTIFICATION
See CLIENT
Search the Mastodon instance for matching tags, accounts, or statuses.
Allowed values for the KIND argument are: "accounts", "hashtags", "statuses".
See RESULTS
See CLIENT
Retrieve the status with the given ID.
See CLIENT
See STATUS
Returns a cons cell of the X and Y coordinates on which the focus in the media should lie.
This is useful for determining a good cropping region.
See METADATA
Follow a new account.
The account can be either an account ID, or an ACCOUNT instance.
It can also be a URI string for a remote account.
Returns the resulting relationship if the account was local, and the
local representation of the remote account if it was remote.
See CLIENT
See ACCOUNT
See RELATIONSHIP
Retrieve a list of accounts that requested to follow you.
This function returns paginated results.
See DO-PAGES
See ACCOUNT
See CLIENT
Returns the number of follow requests.
See SOURCE
Follow a tag.
See CLIENT See TAG
Returns whether the account is following you.
See RELATIONSHIP
relationship
)) ¶automatically generated reader method
relationship
)) ¶automatically generated writer method
Returns a list of followed tags.
This function returns paginated results.
See DO-PAGES
See CLIENT
See TAG
Returns the number of followers the account has.
See ACCOUNT
Returns whether you are following this account.
See RELATIONSHIP
relationship
)) ¶automatically generated reader method
tag
)) ¶automatically generated writer method
relationship
)) ¶automatically generated writer method
Returns the number of users this account is following.
See ACCOUNT
Returns the frame-rate of the video in FPS.
See VIDEO-METADATA
video-metadata
)) ¶automatically generated reader method
video-metadata
)) ¶automatically generated writer method
Get statistics from an instance
See CLIENT
See ACTIVITY
Get the administrator’s announcements See ANNOUNCEMENT
Returns a list of followers for the account.
The account can be an ACCOUNT instance, an account ID, or T for
yourself.
This function returns paginated results.
See DO-PAGES
See CLIENT
See ACCOUNT
Returns a list of accounts the account is following.
The account can be an ACCOUNT instance, an account ID, or T for
yourself.
This function returns paginated results.
See DO-PAGES
See CLIENT
See ACCOUNT
Returns a list of statuses for the account.
The account can be an ACCOUNT instance, an account ID, or T for
yourself.
See CLIENT
See ACCOUNT
See STATUS
Returns the full URL to the account’s header image.
This may be an animated image.
See ACCOUNT
Returns the full URL to the account’s static header image.
See ACCOUNT
Returns the height of the media or card.
See CARD
See IMAGE-METADATA
See VIDEO-METADATA
video-metadata
)) ¶automatically generated reader method
image-metadata
)) ¶automatically generated reader method
card
)) ¶automatically generated writer method
video-metadata
)) ¶automatically generated writer method
image-metadata
)) ¶automatically generated writer method
Returns an array describing daily usage information of the hashtag.
See TAG
See TAG-HISTORY
Returns an HTML snippet for the card’s OEmbed data.
See CARD
Returns the ID of the object as a string.
This ID is used in the API to query the object itself, or properties
related to it. The ID may be an integer, or some other structure encoded
as a string, depending on the instance the object stems from.
About the only thing you can portably do with an ID is determine identity
via STRING=.
See ACCOUNT
See ATTACHMENT
See USER-LIST
See MENTION
See NOTIFICATION
See PUSH-SUBSCRIPTION
See RELATIONSHIP
See REPORT
See STATUS
filter-status
)) ¶automatically generated reader method
id
.
filter-keyword
)) ¶automatically generated reader method
id
.
featured-tag
)) ¶automatically generated reader method
id
.
conversation
)) ¶automatically generated reader method
id
.
scheduled-status
)) ¶automatically generated reader method
id
.
relationship
)) ¶automatically generated reader method
id
.
push-subscription
)) ¶automatically generated reader method
id
.
notification
)) ¶automatically generated reader method
id
.
mention
)) ¶automatically generated reader method
id
.
user-list
)) ¶automatically generated reader method
id
.
attachment
)) ¶automatically generated reader method
id
.
announcement
)) ¶automatically generated reader method
id
.
announcement-status
)) ¶automatically generated reader method
id
.
announcement-account
)) ¶automatically generated reader method
id
.
filter-status
)) ¶automatically generated writer method
id
.
filter-keyword
)) ¶automatically generated writer method
id
.
filter
)) ¶automatically generated writer method
id
.
featured-tag
)) ¶automatically generated writer method
id
.
conversation
)) ¶automatically generated writer method
id
.
status
)) ¶automatically generated writer method
id
.
scheduled-status
)) ¶automatically generated writer method
id
.
report
)) ¶automatically generated writer method
id
.
relationship
)) ¶automatically generated writer method
id
.
push-subscription
)) ¶automatically generated writer method
id
.
poll
)) ¶automatically generated writer method
id
.
notification
)) ¶automatically generated writer method
id
.
mention
)) ¶automatically generated writer method
id
.
user-list
)) ¶automatically generated writer method
id
.
attachment
)) ¶automatically generated writer method
id
.
announcement
)) ¶automatically generated writer method
id
.
announcement-status
)) ¶automatically generated writer method
id
.
announcement-account
)) ¶automatically generated writer method
id
.
Returns response from external identity provider.
See CLIENT
Preview (URL)
See CARD
Returns the ID of the account this status is a reply to.
See STATUS
Returns the ID of the status this status is a reply to.
See STATUS
status
)) ¶automatically generated reader method
status-params
)) ¶automatically generated reader method
status
)) ¶automatically generated writer method
status-params
)) ¶automatically generated writer method
Retrieve the instance information that the client is connected to.
See INSTANCE
See CLIENT
Accessor to the application key the client is using to connect.
Unless manually filled in, this will be automatically set by REGISTER.
See CLIENT
See REGISTER
filter-results
)) ¶automatically generated reader method
filter-results
)) ¶automatically generated writer method
Returns the type/kind of object this instance is representing.
See ATTACHMENT
See CARD
See NOTIFICATION
notification
)) ¶automatically generated reader method
kind
.
attachment
)) ¶automatically generated reader method
kind
.
notification
)) ¶automatically generated writer method
kind
.
card
)) ¶automatically generated writer method
kind
.
attachment
)) ¶automatically generated writer method
kind
.
Returns the ISO-6391 code for the language this status is in.
See STATUS
A list of ISO-6391 language codes that the instance advertises.
See INSTANCE
Returns the last read ID of an entity (status or notification)
Returns the last STATUS of the conversation
conversation
)) ¶automatically generated reader method
conversation
)) ¶automatically generated writer method
Timestamp of the last status mentioning the tag
featured-tag
)) ¶automatically generated reader method
featured-tag
)) ¶automatically generated writer method
Returns whether the account is locked and requires confirming follow requests.
See ACCOUNT
Create a new media attachment.
FILE must be a pathname. FOCUS should be, if given, a cons of X and Y
coordinates on which the focus should be put in the media.
Returns the new media ATTACHMENT instance.
See ATTACHMENT
See CLIENT
Files a new report against the given account.
The account can be an ACCOUNT instance, or an ID of one.
STATUSES must be a list of either STATUS instances or IDs of such that
refer to the offending statuses. COMMENT must be a string describing
the offence.
See ACCOUNT
See STATUS
See CLIENT
Create a new status.
The arguments should be seen as follows:
STATUS — The content of the status update. Should be plain
text.
IN-REPLY-TO — May be a STATUS instance or ID to which this status
should reply to.
MEDIA — May be an attachment, or a list of up to four
attachments. See below for the handling of media
attachments.
SENSITIVE — Whether the content contains sensitive material.
SPOILER-TEXT — Denotes the text to show in place of the content
before the content is revealed. Forces sensitive.
VISIBILITY — May denote how visible the status should be. Can be
one of the following:
:DIRECT The status can only be seen by mentions
:PRIVATE The status can only be seen by you
:UNLISTED The status can only be seen by link
:PUBLIC The status appears publicly on timelines
LANGUAGE — May be an ISO-639 code of the language the status
text is in.
SCHEDULED-AT — If non nil will post this status at the date represented
by this argument.
POLL-OPTIONS — If non nil provides a list of options for the poll attached
to this status.
POLL-EXPIRE-SECONDS — The number of seconds before the poll will expires.
POLL-MULTIPLE — If non nil the polls admits more than one selected
entry by each users.
POLL-HIDE-TOTALS — If non null the total of the expressed votes
will not be displayed
IDEMPOTENCY-KEY — May be any string. Used to prevent duplicate
submissions of the same status.
Media attachments can be one of the following types:
INTEGER — The referenced attachment is used.
ATTACHMENT — The referenced attachment is used.
PATHNAME — A new media attachment is created automatically and
its new ID is used.
Returns the newly created status instance.
See CLIENT
See STATUS
See ATTACHMENT
Create or update a push notification subscription.
ALERTS should be a list of desired alerts:
:FOLLOWS :FAVOURITES :REBLOGS :MENTIONS
Returns the resulting PUSH-SUBSCRIPTION instance.
See CLIENT
See PUSH-SUBSCRIPTION
Create a new user list with the given title.
See USER-LIST
See CLIENT
Marks a conversation ad already read.
See CONVERSATION
See CLIENT
Retuns the markers
See MARKERS
Returns if the user reacted to this announcement.
Returns a list of up to four media attachments.
See ATTACHMENT
See STATUS
WIP
See status-params
status-params
)) ¶automatically generated reader method
status-params
)) ¶automatically generated writer method
Returns an array of mentions used in the status.
See STATUS
See MENTION
status
)) ¶automatically generated reader method
announcement
)) ¶automatically generated reader method
status
)) ¶automatically generated writer method
announcement
)) ¶automatically generated writer method
Returns the error message string for the failed request.
See REQUEST-FAILED
request-failed
)) ¶Returns a metadata instance for additional information about the attachment’s media.
See ATTACHMENT
attachment
)) ¶automatically generated reader method
attachment
)) ¶automatically generated writer method
If not NIL, returns the name of the account to which this account has moved.
See ACCOUNT
Returns if the poll admits multiple choices
See POLL
Mute a new account or conversation.
The account can be either an account ID, or an ACCOUNT instance. It can also be a STATUS in which case that conversation is muted.
Returns the resulting relationship for an account mute, or T for a
conversation mute.
See CLIENT
See ACCOUNT
See RELATIONSHIP
Mute the conversation of the given status.
This means you will no longer receive mention notifications for the
given status’ conversation thread.
Returns the referenced status.
See STATUS
See CLIENT
Returns whether this status should be muted.
See STATUS
Returns a list of accounts that you have muted.
This function returns paginated results.
See DO-PAGES
See ACCOUNT
See CLIENT
Returns whether the account is muted by you.
See RELATIONSHIP
relationship
)) ¶automatically generated reader method
relationship
)) ¶automatically generated writer method
Returns whether notifications from the account are muted by you.
See RELATIONSHIP
relationship
)) ¶automatically generated reader method
relationship
)) ¶automatically generated writer method
Returns the emoji specification: unicode value or string representation (i.e. ":name:").
featured-tag
)) ¶automatically generated reader method
name
.
status-tag
)) ¶automatically generated reader method
name
.
reaction
)) ¶automatically generated reader method
name
.
application
)) ¶automatically generated reader method
name
.
field
)) ¶automatically generated reader method
name
.
featured-tag
)) ¶automatically generated writer method
name
.
tag
)) ¶automatically generated writer method
name
.
status-tag
)) ¶automatically generated writer method
name
.
reaction
)) ¶automatically generated writer method
name
.
application
)) ¶automatically generated writer method
name
.
field
)) ¶automatically generated writer method
name
.
Returns the user biography.
See SOURCE
Returns a list of notifications about status updates.
See NOTIFICATION
See CLIENT
Returns the possible choices for this poll.
See POLL
Returns metadata information for the original version of the attachment media, if available.
See METADATA
See IMAGE-METADATA
See VIDEO-METADATA
Returns the choice of an user (requires to be called with a valid user token.
See POLL
Returns ...
See SCHEDULED-STATUS
scheduled-status
)) ¶automatically generated reader method
scheduled-status
)) ¶automatically generated writer method
Returns the original status this status is a reblog of.
See STATUS
Retrieve the instances that the server knows.
See CLIENT
Pin the given status to your profile.
The status can either be a STATUS instance, or an ID of one.
Returns the referenced status.
See STATUS
See CLIENT
Returns whether this status is pinned on the user’s profile.
See STATUS
Returns a poll attached to this status, nil if no poll is attached.
See STATUS
Votes for choices in a poll.
See CLIENT
See POLL
See POLL-OPTION
Returns a poll
See CLIENT See POLL See POLL-OPTION
Return the default language for post.
See PREFERENCES
preferences
)) ¶automatically generated reader method
preferences
)) ¶automatically generated writer method
Returns if flag post as "sensible" by default.
See PREFERENCES
preferences
)) ¶automatically generated reader method
preferences
)) ¶automatically generated writer method
Returns the default visibility for post. Possible values are:
:PUBLIC – visible by all
:UNLISTED – visible by all but not shown in timeline
:PRIVATE – visible by followers only
:DIRECT – visible as conversation
See PREFERENCES
preferences
)) ¶automatically generated reader method
preferences
)) ¶automatically generated writer method
Returns the preferences (setting shared by all the clients)
Returns a convenient JSON preview for links contained in a status.
See STATUS
Returns the URL for the media’s preview, which may be resized and cropped.
See ATTACHMENT
attachment
)) ¶automatically generated reader method
attachment
)) ¶automatically generated writer method
Returns the default privacy mode for the statuses. possible values are:
:PUBLIC – visible by all
:UNLISTED – visible by all but not shown in timeline
:PRIVATE – visible by followers only
:DIRECT – visible as conversation
See SOURCE
Returns the URL of the profile on the identity provider
See IDENTITY-PROOF
identity-proof
)) ¶automatically generated reader method
identity-proof
)) ¶automatically generated writer method
Returns the URL of the proof of identity on the identity provider
See IDENTITY-PROOF
identity-proof
)) ¶automatically generated reader method
identity-proof
)) ¶automatically generated writer method
Returns the name of the identity provider
See IDENTITY-PROOF
identity-proof
)) ¶automatically generated reader method
identity-proof
)) ¶automatically generated writer method
Returns the name of the status’ instance.
See CARD
Returns the URL to the status’ instance.
See CARD
Returns the username on the identity provider
See IDENTITY-PROOF
identity-proof
)) ¶automatically generated reader method
identity-proof
)) ¶automatically generated writer method
Returns if this announcement is active or not.
See ANNOUNCEMENT
announcement
)) ¶automatically generated reader method
announcement
)) ¶automatically generated writer method
Returns the date when this announcement was published.
See ANNOUNCEMENT
announcement
)) ¶automatically generated reader method
announcement
)) ¶automatically generated writer method
Performs a query request against the client.
The endpoint should be the full path on the server. The parameters
should be a plist of keys and values to be sent as request parameters.
The list is transformed via PARAM-PLIST->ALIST. By default this uses
the GET request method. You can specify a different method with the
special parameter :HTTP-METHOD.
Note that no matter what, the content-type of the request will be
application/x-www-form-urlencoded meaning it is not suitable to upload
files using QUERY.
See CLIENT
See PARAM-PLIST->ALIST
See SUBMIT
filter-results
)) ¶automatically generated reader method
filter-results
)) ¶automatically generated writer method
Returns the number of users that reacted to an announcement.
Returns the reactions to this announcement
See ANNOUNCEMENT
See REACTION
announcement
)) ¶automatically generated reader method
announcement
)) ¶automatically generated writer method
:SHOW-ALL – show all media :HIDE-ALL – hide all media
See PREFERENCES
preferences
)) ¶automatically generated reader method
preferences
)) ¶automatically generated writer method
Returns if expands posts marked as ’sensible’.
See PREFERENCES
preferences
)) ¶automatically generated reader method
preferences
)) ¶automatically generated writer method
Returns if this announcement has been read by the user
See ANNOUNCEMENT
announcement
)) ¶automatically generated reader method
announcement
)) ¶automatically generated writer method
Reblog the given status.
The status can either be a STATUS instance, or an ID of one.
Returns the new status which is a reblog of the given status.
See STATUS
See CLIENT
Returns whether you have reblogged this status.
See STATUS
Retrieve the list of accounts that reblogged the status.
The status can either be a STATUS instance, or an ID of one.
This function returns paginated results.
See DO-PAGES
See STATUS
See CLIENT
See ACCOUNT
Returns the number of reblogs this status has received.
See STATUS
Accessor to the redirect URL used to complete the authentication flow.
Unless manually set, this is defaulted to "urn:ietf:wg:oauth:2.0:oob"
which will display the authentication code to the user on the website
during authorisation.
See CLIENT
See AUTHORIZE
Register the application on the Mastodon instance.
This will cause the KEY and SECRET to be set in the client if the
registration succeeds.
Returns the client instance, the key, and the secret.
See CLIENT
Returns if is possible to register an user with this instance.
See INSTANCE
Reject the follow request of the given account.
See CLIENT
See ACCOUNT
Returns a list of relationships for the given accounts.
The accounts can be a list of IDs or ACCOUNT instances.
See CLIENT
See ACCOUNT
See RELATIONSHIP
Returns the remote URL if the attachment resides on a remote instance.
See ATTACHMENT
attachment
)) ¶automatically generated reader method
attachment
)) ¶automatically generated writer method
Remove a keyword to a filter.
See FILTER
Remove existing accounts from the user-list.
The list can be either a USER-LIST instance, or an ID of one.
The accounts in the list can be either account instances, or IDs of
accounts.
See ACCOUNT
See CLIENT
See USER-LIST
Returns the number of replies this status has received.
See STATUS
Returns a list of submitted reports.
See REPORT
See CLIENT
Returns whether you have requested a follow to the account.
See RELATIONSHIP
relationship
)) ¶automatically generated reader method
relationship
)) ¶automatically generated writer method
Returns a list of matching accounts.
See RESULTS
Returns a list of matching status.
See RESULTS
Returns a list of matching hashtags as TAGS.
See RESULTS
See TAGS
Save a marker for the last status read and the last notification read.
See MARKERS
Returns ...
See SCHEDULED-STATUS
scheduled-status
)) ¶automatically generated reader method
status-params
)) ¶automatically generated reader method
scheduled-status
)) ¶automatically generated writer method
status-params
)) ¶automatically generated writer method
Returns the oauth access token scope (space separated fields).
See TOKEN
Accessor to the list of scopes the client will have access to.
A scope can be one of :READ, :WRITE, :FOLLOW. Unless manually set, this
defaults to a list of all three scopes.
See CLIENT
See REGISTER
Search for accounts on the Mastodon network.
This is the only way of retrieving accounts outside of the local
instance.
Returns a list of matching accounts.
See CLIENT
See ACCOUNT
Accessor to the application secret the client is using to connect.
Unless manually filled in, this will be automatically set by REGISTER.
See CLIENT
See REGISTER
Returns if the the user biography.
See SOURCE
source
)) ¶automatically generated reader method
status
)) ¶automatically generated reader method
status-params
)) ¶automatically generated reader method
source
)) ¶automatically generated writer method
status
)) ¶automatically generated writer method
status-params
)) ¶automatically generated writer method
The public key signature for verification of deliveries.
See PUSH-SUBSCRIPTION
push-subscription
)) ¶automatically generated reader method
push-subscription
)) ¶automatically generated writer method
Returns a short description of the object.
See INSTANCE
Returns the short code to display the emoji.
See EMOJI
Returns if this user has boosted your toots.
See RELATIONSHIP
relationship
)) ¶automatically generated reader method
relationship
)) ¶automatically generated writer method
Returns the size of the image.
See IMAGE-METADATA
image-metadata
)) ¶automatically generated reader method
size
.
image-metadata
)) ¶automatically generated writer method
size
.
Returns metadata information for the small version of the attachment media, if available.
See METADATA
See IMAGE-METADATA
See VIDEO-METADATA
Returns a hash table of extra information about the account.
This is only set for accounts retrieved through verify-credentials.
See ACCOUNT
Returns the spoiler text for the status.
See STATUS
status
)) ¶automatically generated reader method
status-params
)) ¶automatically generated reader method
status
)) ¶automatically generated writer method
status-params
)) ¶automatically generated writer method
Returns a date when announcement will start.
See ANNOUNCEMENT
announcement
)) ¶automatically generated reader method
announcement
)) ¶automatically generated writer method
Returns the static image of the emoji.
See EMOJI
Statistics about this instance.
See INSTANCE-STATS
See INSTANCE
Returns the status the notification is about.
See NOTIFICATION
notification
)) ¶automatically generated reader method
notification
)) ¶automatically generated writer method
Returns the status counts for this instance.
See INSTANCE-STATS
instance-stats
)) ¶automatically generated reader method
instance-stats
)) ¶automatically generated writer method
filter-status
)) ¶automatically generated reader method
filter-keyword
)) ¶automatically generated reader method
filter-status
)) ¶automatically generated writer method
filter-keyword
)) ¶automatically generated writer method
filter-results
)) ¶automatically generated reader method
filter-results
)) ¶automatically generated writer method
Returns an array of FILTER-STATUS of statuses that matched this filter
filter
)) ¶automatically generated reader method
announcement
)) ¶automatically generated reader method
filter
)) ¶automatically generated writer method
announcement
)) ¶automatically generated writer method
Returns the number of statuses the account has made.
See ACCOUNT
featured-tag
)) ¶automatically generated reader method
featured-tag
)) ¶automatically generated writer method
Performs a submission request against the client.
The endpoint should be the full path on the server. The parameters
should be a plist of keys and values to be sent as request parameters.
The list is transformed via PARAM-PLIST->ALIST. By default this uses
the POST request method. You can specify a different method with the
special parameter :HTTP-METHOD. You can also specify an idempotency
key with the special parameter :IDEMPOTENCY-KEY.
Note that no matter what, the content-type of the request will be multipart/form-data meaning it is not suitable to use for GET endpoints.
See CLIENT
See PARAM-PLIST->ALIST
See QUERY
Retrieve the current push subscription settings.
See CLIENT
See PUSH-SUBSCRIPTION
Returns information about a tag.
SEE TAG
client
) (tag status-tag
)) ¶Returns an array of tags used in the status.
See STATUS
See TAG
WIP
See status-params
status-params
)) ¶automatically generated reader method
text
.
status-params
)) ¶automatically generated writer method
text
.
Returns a shorter URL for usage in text snippets if the attachment is on the local instance.
See ATTACHMENT
attachment
)) ¶automatically generated reader method
attachment
)) ¶automatically generated writer method
banner of this instance.
See INSTANCE
Returns statuses for the specified timeline.
The KIND can be one of the following:
:HOME — Returns statuses for your home timeline. This includes
your own and statuses of all accounts you follow.
:PUBLIC — Returns statuses for your instance’s public timeline.
STRING — Returns statuses for the given user-list’s accounts.
USER-LIST — Returns statuses for the given user-list’s accounts.
TAG — Returns statuses for the given hashtag.
See STATUS
See CLIENT
See USER-LIST
Returns statuses for the given hashtag.
See CLIENT
See TAG
See STATUS
Returns the title of the object.
See CARD
See INSTANCE
See USER-LIST
poll-option
)) ¶automatically generated reader method
user-list
)) ¶automatically generated reader method
instance
)) ¶automatically generated reader method
filter
)) ¶automatically generated writer method
poll-option
)) ¶automatically generated writer method
user-list
)) ¶automatically generated writer method
instance
)) ¶automatically generated writer method
Returns the oauth access token type ("Bearer" for mastodon).
See TOKEN
Returns a list of trending hashtags.
See CLIENT
Unblock an account or domain.
The account can be either an account ID, or an ACCOUNT instance.
It can also be a string, in which case the corresponding domain is
unblocked.
Returns the resulting relationship in the case of an account, or T
in the case of a domain.
See CLIENT
See ACCOUNT
See RELATIONSHIP
Remove a STATUS to user’s bookmark.
See CLIENT
See STATUS
Unfavourite the given status.
The status can either be a STATUS instance, or an ID of one.
Returns the referenced status.
See STATUS
See CLIENT
Unfollow an account.
The account can be either an account ID, or an ACCOUNT instance.
Returns the resulting relationship.
See CLIENT
See ACCOUNT
See RELATIONSHIP
Unfollow a tag.
See CLIENT See TAG
Unmute a new account or conversation.
The account can be either an account ID, or an ACCOUNT instance. It can also be a STATUS in which case that conversation is unmuted.
Returns the resulting relationship for an account unmute, or T for a
conversation unmute.
See CLIENT
See ACCOUNT
See RELATIONSHIP
Unmute the conversation of the given status.
This means you will receive mention notifications for the given status’
conversation thread again.
Returns the referenced status.
See STATUS
See CLIENT
Unpin the given status from your profile.
The status can either be a STATUS instance, or an ID of one.
Returns the referenced status.
See STATUS
See CLIENT
Returns non nil if this conversation has been marked not red
conversation
)) ¶automatically generated reader method
conversation
)) ¶automatically generated writer method
Remove the reblog of the given status.
The status can either be a STATUS instance, or an ID of one.
Returns the original status that was given as a fresh instance.
See STATUS
See CLIENT
Update some of the user’s profile settings.
FIELDS should be a plist of the desired fields, with alternating field
names and field values. The keys can be strings to more easily control
the look of the fields.
Returns the updated account.
This updates the ACCOUNT field in the client.
See CLIENT
See ACCOUNT
Update an existing filter.
See CLIENT
See FILTER
Updates the media attachment’s metadata.
This can only be performed before the attachment is used in a status.
Returns the new media ATTACHMENT instance.
See CLIENT
See ATTACHMENT
client
) (attachment attachment
) &rest args) ¶Update the user list’s properties.
The list can be either a USER-LIST instance, or an ID of one.
This is not used to add or remove accounts from the list. See
ADD/REMOVE-USER-LIST-ACCOUNTS for that.
See USER-LIST
See CLIENT
Update time
See IDENTITY-PROOF
identity-proof
)) ¶automatically generated reader method
marker
)) ¶automatically generated reader method
announcement
)) ¶automatically generated reader method
identity-proof
)) ¶automatically generated writer method
marker
)) ¶automatically generated writer method
announcement
)) ¶automatically generated writer method
Returns the instance’s URI.
See INSTANCE
See STATUS
Returns if the URL of a custom emoji.
status
)) ¶automatically generated reader method
url
.
status-tag
)) ¶automatically generated reader method
url
.
reaction
)) ¶automatically generated reader method
url
.
mention
)) ¶automatically generated reader method
url
.
attachment
)) ¶automatically generated reader method
url
.
announcement-status
)) ¶automatically generated reader method
url
.
announcement-account
)) ¶automatically generated reader method
url
.
tag
)) ¶automatically generated writer method
url
.
status
)) ¶automatically generated writer method
url
.
status-tag
)) ¶automatically generated writer method
url
.
reaction
)) ¶automatically generated writer method
url
.
mention
)) ¶automatically generated writer method
url
.
emoji
)) ¶automatically generated writer method
url
.
card
)) ¶automatically generated writer method
url
.
attachment
)) ¶automatically generated writer method
url
.
announcement-status
)) ¶automatically generated writer method
url
.
announcement-account
)) ¶automatically generated writer method
url
.
Returns a list of URLs for the streaming API.
See INSTANCE
Returns the number of statuses that made use of the hashtag on that day.
See TAG-HISTORY
tag-history
)) ¶automatically generated reader method
tag-history
)) ¶automatically generated writer method
Returns the user counts for this instance.
See INSTANCE-STATS
instance-stats
)) ¶automatically generated reader method
instance-stats
)) ¶automatically generated writer method
Retrieve a list of accounts in the user list.
The user list can be either a USER-LIST instance, or an ID of one.
This is SETFable for convenience, though it will usually be much more
efficient to simply use ADD/REMOVE-USER-LIST-ACCOUNTS instead.
This function returns paginated results.
See DO-PAGES
See USER-LIST
See CLIENT
Retrieve a list of up to twenty of the account’s user lists.
The account can be an ACCOUNT instance, an account ID, or T for
yourself.
See USER-LIST
See CLIENT
Returns the username of the object.
The username does not include the instance/domain name.
See ACCOUNT
See MENTION
mention
)) ¶automatically generated reader method
announcement-account
)) ¶automatically generated reader method
mention
)) ¶automatically generated writer method
announcement-account
)) ¶automatically generated writer method
Returns the key for PUSH streaming API.
See APPLICATION
See CLIENT
application
)) ¶automatically generated reader method
application
)) ¶automatically generated writer method
Checks and returns the Oauth credentials for this application.
See CLIENT
See APPLICATION
Returns your own account.
This updates the ACCOUNT field in the client.
See CLIENT
See ACCOUNT
Returns the instance’s Mastodon version.
See INSTANCE
Returns the default visibility of the status.
Can be one of :PUBLIC :UNLISTED :PRIVATE :DIRECT
See STATUS
status
)) ¶automatically generated reader method
status-params
)) ¶automatically generated reader method
status
)) ¶automatically generated writer method
status-params
)) ¶automatically generated writer method
Returns if an user has voted (requires to be called with a valid user token.
See POLL
Returns the number of accounts that voted so far, the value of this slot is nil if
the poll prevent multiple choice.
See POLL
Returns the number of votes collected so far.
See POLL
poll-option
)) ¶automatically generated reader method
poll
)) ¶automatically generated writer method
poll-option
)) ¶automatically generated writer method
Returns the website URL of the object.
See APPLICATION
See CLIENT
application
)) ¶automatically generated reader method
application
)) ¶automatically generated writer method
Retrieve stats of the last 3 month activity of this instance bin size is week.
See CLIENT
See ACTIVITY
Returns if the filter take into account word limit
See FILTER
filter-keyword
)) ¶automatically generated reader method
filter-keyword
)) ¶automatically generated writer method
Returns the width of the media or card.
See CARD
See IMAGE-METADATA
See VIDEO-METADATA
video-metadata
)) ¶automatically generated reader method
image-metadata
)) ¶automatically generated reader method
card
)) ¶automatically generated writer method
video-metadata
)) ¶automatically generated writer method
image-metadata
)) ¶automatically generated writer method
conversation
) stream) ¶instance-stats
) stream) ¶scheduled-status
) stream) ¶featured-tag
) stream) ¶announcement
) stream) ¶image-metadata
) stream) ¶filter-status
) stream) ¶poll-option
) stream) ¶application
) stream) ¶status-tag
) stream) ¶preferences
) stream) ¶push-subscription-alerts
) stream) ¶audio-metadata
) stream) ¶announcement-account
) stream) ¶notification
) stream) ¶announcement-status
) stream) ¶video-metadata
) stream) ¶tag-history
) stream) ¶push-subscription
) stream) ¶relationship
) stream) ¶identity-proof
) stream) ¶attachment
) stream) ¶filter-keyword
) stream) ¶filter-results
) stream) ¶Error signalled when a request against the Mastodon API failed.
See CODE
See DATA
See MESSAGE
Represents a user account on the mastodon instance.
Note that this may also be a remote account that resides on another
instance.
See ID
See USERNAME
See ACCOUNT-NAME
See DISPLAY-NAME
See LOCKED
See CREATED-AT
See FOLLOWERS-COUNT
See FOLLOWING-COUNT
See STATUSES-COUNT
See NOTE
See URL
See AVATAR
See AVATAR-STATIC
See HEADER
See HEADER-STATIC
See MOVED
See FIELDS
See BOT
See SOURCE
accept-request
.
(setf account-name)
.
account-name
.
(setf avatar)
.
avatar
.
(setf avatar-static)
.
avatar-static
.
block
.
(setf bot)
.
bot
.
(setf created-at)
.
created-at
.
decode-entity
.
(setf discoverable)
.
discoverable
.
(setf display-name)
.
display-name
.
(setf emojis)
.
emojis
.
(setf fields)
.
fields
.
follow
.
(setf followers-count)
.
followers-count
.
(setf following-count)
.
following-count
.
get-followers
.
get-following
.
get-statuses
.
(setf header)
.
header
.
(setf header-static)
.
header-static
.
(setf id)
.
id
.
(setf locked)
.
locked
.
make-report
.
(setf moved)
.
moved
.
mute
.
(setf note)
.
note
.
print-object
.
reject-request
.
relationships
.
(setf source)
.
source
.
(setf statuses-count)
.
statuses-count
.
unblock
.
unfollow
.
unmute
.
(setf url)
.
url
.
user-lists
.
(setf username)
.
username
.
(error "username required for a account.")
:username
(error "account-name required for a account.")
:account-name
(error "display-name required for a account.")
:display-name
(error "locked required for a account.")
:locked
(error "emojis required for a account.")
:emojis
(error "discoverable required for a account.")
:discoverable
(error "created-at required for a account.")
:created-at
(error "followers-count required for a account.")
:followers-count
(error "following-count required for a account.")
:following-count
(error "statuses-count required for a account.")
:statuses-count
(error "avatar required for a account.")
:avatar
(error "avatar-static required for a account.")
:avatar-static
(error "header required for a account.")
:header
(error "header-static required for a account.")
:header-static
:moved
:fields
:source
Representation of an administrator’s announce
See ID
See CONTENT
See STARTS-AT
See ENDS-AT
See PUBLISHED
See ALL-DAY
See PUBLISHED-AT
See UPDATED-AT
See READP
See MENTIONS
See STATUSES
See TAGS
See EMOJIS
See REACTIONS
(setf all-day)
.
all-day
.
(setf content)
.
content
.
decode-entity
.
(setf emojis)
.
emojis
.
(setf ends-at)
.
ends-at
.
(setf id)
.
id
.
(setf mentions)
.
mentions
.
print-object
.
(setf published)
.
published
.
(setf published-at)
.
published-at
.
(setf reactions)
.
reactions
.
(setf readp)
.
readp
.
(setf starts-at)
.
starts-at
.
(setf statuses)
.
statuses
.
(setf tags)
.
tags
.
(setf updated-at)
.
updated-at
.
(error "content required for a announcement.")
:content
:starts-at
:ends-at
(error "published required for a announcement.")
:published
(error "all-day required for a announcement.")
:all-day
(error "published-at required for a announcement.")
:published-at
(error "updated-at required for a announcement.")
:updated-at
(error "readp required for a announcement.")
:readp
(error "mentions required for a announcement.")
:mentions
(error "statuses required for a announcement.")
:statuses
(error "tags required for a announcement.")
:tags
tags
.
(error "emojis required for a announcement.")
:emojis
(error "reactions required for a announcement.")
:reactions
List of accounts related to an announcement
See ANNOUNCEMENT
See ID
See USERNAME
See ACCOUNT-NAME
See URL
(error "username required for a announcement-account.")
:username
(error "account-name required for a announcement-account.")
:account-name
List of statuses related to an announcement
See ANNOUNCEMENT
See ID
See URL
Representation of an application as registered on a Mastodon instance.
See NAME
See WEBSITE
See VAPID-KEY
Representation of a media attachment for a status.
See ID
See KIND
See URL
See REMOTE-URL
See PREVIEW-URL
See TEXT-URL
See METADATA
See DESCRIPTION
See BLURHASH
(error "kind required for a attachment.")
:kind
kind
.
(error "preview-url required for a attachment.")
:preview-url
:remote-url
:text-url
:metadata
:description
:blurhash
Metadata for audio.
See AUDIO-LENGTH See AUDIO-ENCODE See AUDIO-BITRATE See AUDIO-CHANNELS See DURATION
:audio-length
:duration
:audio-encode
:audio-bitrate
:audio-channels
Cards represent all information to summarise a status.
See URL
See TITLE
See DESCRIPTION
See IMAGE
See KIND
See AUTHOR-NAME
See AUTHOR-URL
See PROVIDER-NAME
See PROVIDER-URL
See HTML
See WIDTH
See HEIGHT
See IMAGE
See EMBED-URL
(setf author-name)
.
author-name
.
(setf author-url)
.
author-url
.
decode-entity
.
(setf description)
.
description
.
(setf embed-url)
.
embed-url
.
(setf height)
.
height
.
(setf html)
.
html
.
(setf image)
.
image
.
(setf kind)
.
kind
.
print-object
.
(setf provider-name)
.
provider-name
.
(setf provider-url)
.
provider-url
.
(setf title)
.
title
.
(setf url)
.
url
.
(setf width)
.
width
.
(error "title required for a card.")
:title
(error "description required for a card.")
:description
:author-name
:author-url
:provider-name
:provider-url
:width
:height
:image
:embed-url
Representation of an application client connecting to a Mastodon instance.
If you are creating a library providing some kind of service based on
Mastodon, you should create a wrapper function that fills in the fields
like NAME, REDIRECT, SCOPES, and WEBSITE, but lets the user specify the
BASE so that it can be used against any Mastodon instance.
The fields KEY, SECRET, and ACCESS-TOKEN are specific to your
application, Mastodon instance, and the user using the application. You
should save these fields away somewhere after they’ve been initialised
so that they can be re-used at a later point without having to re-
register and re-authorise.
The KEY and SECRET will be filled in by REGISTER. The ACCESS-TOKEN will
be filled in by AUTHORIZE once the user calls it with a valid
AUTHORIZATION-CODE retrieved by authorizing the application.
Generally the procedure for using a client is as follows: fill in the BASE and NAME, call AUTHORIZE and instruct the user to follow the URL from the second return value. Make the user call AUTHORIZE again with the code from the website as the second argument. Once that’s done, you should be fine to make any calls necessary from there on out. Make sure to persist the KEY, SECRET, and ACCESS-TOKEN for future use. ACCESS-TOKENs should not expire unless the user revokes access manually.
CLIENT instances can be dumped to FASLs.
See BASE
See KEY
See SECRET
See ACCESS-TOKEN
See NAME
See REDIRECT
See SCOPES
See WEBSITE
See ACCOUNT
See REGISTER
See AUTHORIZE
See DEFAULT-HEADERS
See QUERY
See SUBMIT
accept-request
.
accept-request
.
(setf access-token)
.
access-token
.
account
.
(setf account)
.
account-directory
.
add-filter-keyword
.
add-reaction-announcement
.
add-user-list-accounts
.
add-user-list-accounts
.
authorize
.
(setf base)
.
base
.
block
.
block
.
blocked-domains
.
blocks
.
bookmark
.
bookmark
.
bookmarks
.
card
.
card
.
context
.
context
.
conversations
.
create-filter
.
default-headers
.
delete-conversation
.
delete-filter
.
delete-notification
.
delete-notification
.
delete-notification
.
delete-status
.
delete-status
.
delete-subscription
.
delete-user-list
.
dismiss-announcement
.
dismiss-reaction-announcement
.
edit-status
.
edit-status
.
emojis
.
endorsements
.
favourite
.
favourite
.
favouriters
.
favouriters
.
favourites
.
filter
.
filter
.
filter-keywords
.
filters
.
find-account
.
find-filter
.
find-list
.
find-notification
.
find-results
.
find-status
.
follow
.
follow
.
follow-requests
.
follow-tag
.
follow-tag
.
followed-tags
.
get-activity
.
get-announcements
.
get-followers
.
get-followers
.
get-followers
.
get-following
.
get-following
.
get-following
.
get-statuses
.
get-statuses
.
get-statuses
.
identity-proof
.
instance
.
(setf key)
.
key
.
make-load-form
.
make-media
.
make-report
.
make-report
.
make-status
.
make-subscription
.
make-user-list
.
mark-read-conversation
.
markers
.
mute
.
mute
.
mute
.
mute-conversation
.
mute-conversation
.
mutes
.
(setf name)
.
name
.
notifications
.
oembed
.
peers
.
pin
.
pin
.
poll-vote
.
poll-vote
.
polls
.
polls
.
preferences
.
print-object
.
query
.
query-url
.
reblog
.
reblog
.
rebloggers
.
rebloggers
.
(setf redirect)
.
redirect
.
register
.
reject-request
.
reject-request
.
relationships
.
relationships
.
remove-filter-keyword
.
remove-user-list-accounts
.
remove-user-list-accounts
.
reports
.
save-markers
.
(setf scopes)
.
scopes
.
search-accounts
.
(setf secret)
.
secret
.
status-ensure-media-id
.
status-ensure-media-id
.
status-ensure-media-id
.
status-ensure-media-id
.
status-ensure-media-id
.
status-ensure-media-id
.
submit
.
subscription
.
tag-information
.
tag-information
.
tag-information
.
timeline
.
timeline
.
timeline
.
timeline
.
timeline
.
timeline-tag
.
trends
.
unblock
.
unblock
.
unbookmark
.
unbookmark
.
unfavourite
.
unfavourite
.
unfollow
.
unfollow
.
unfollow-tag
.
unfollow-tag
.
unmute
.
unmute
.
unmute
.
unmute-conversation
.
unmute-conversation
.
unpin
.
unpin
.
unreblog
.
unreblog
.
update-credentials
.
update-filter
.
update-media
.
update-media
.
update-user-list
.
update-user-list
.
(setf user-list-accounts)
.
user-list-accounts
.
user-list-accounts
.
user-lists
.
user-lists
.
user-lists
.
verify-app-credentials
.
verify-credentials
.
(setf website)
.
website
.
weekly-activity
.
Initarg | Value |
---|---|
:base | (error base required.) |
:key | nil |
:secret | nil |
:access-token | nil |
:name | (error name required.) |
:redirect | urn:ietf:wg:oauth:2.0:oob |
:scopes | (quote (read write follow)) |
:website | nil |
:secret
:access-token
:redirect
:scopes
:website
An object representing a status’ context.
Contexts are used to represent reply chains.
See ANCESTORS
See DESCENDANTS
Representation of a private conversation (currently a conversation is private if visibility of a status is :DIRECT)
See ID
See ACCOUNTS
See UNREAD
See LAST-STATUS
See VISIBILITY
See STATUS
(error "id required for a conversation.")
:id
id
.
(error "accounts required for a conversation.")
:accounts
(error "unread required for a conversation.")
:unread
(error "last-status required for a conversation.")
:last-status
Representation of a custom emoticon on the instance.
See SHORTCODE
See URL
See STATIC-URL
See VISIBLE-IN-PICKER
See CATEGORY
(error "shortcode required for a emoji.")
:shortcode
(error "static-url required for a emoji.")
:static-url
(error "visible-in-picker required for a emoji.")
:visible-in-picker
:category
Superclass for all objects returned by Mastodon API queries.
See DECODE-ENTITY
account
.
activity
.
announcement
.
announcement-account
.
announcement-status
.
application
.
attachment
.
audio-metadata
.
card
.
context
.
conversation
.
emoji
.
featured-tag
.
field
.
filter
.
filter-keyword
.
filter-results
.
filter-status
.
identity-proof
.
image-metadata
.
instance
.
instance-stats
.
marker
.
mention
.
metadata
.
notification
.
poll
.
poll-option
.
preferences
.
push-subscription
.
push-subscription-alerts
.
reaction
.
relationship
.
report
.
results
.
scheduled-status
.
source
.
status
.
status-params
.
status-tag
.
tag
.
tag-history
.
token
.
user-list
.
video-metadata
.
Representation of tags most visited by a profile
See ID
See NAME
See STATUSES-COUNT
See LAST-STATUS-AT
(error "name required for a featured-tag.")
:name
name
.
(error "statuses-count required for a featured-tag.")
:statuses-count
(error "last-status-at required for a featured-tag.")
:last-status-at
Representation of a filter (defined by the user) to make invisible unwanted statuses
See ID
See TITLE
See FILTER-CONTEXT
See EXPIRES-AT
See FILTER-KEYWORD
See FILTER-STATUSES
(error "title required for a filter.")
:title
(error "filter-context required for a filter.")
:filter-context
(error "expires-at required for a filter.")
:expires-at
(error "filter-action required for a filter.")
:filter-action
(error "keywords required for a filter.")
:keywords
(error "statuses required for a filter.")
:statuses
(error "status-id required for a filter-keyword.")
:status-id
(error "whole-word required for a filter-keyword.")
:whole-word
Represents a status that trigger trigger the filter
See ID
See STATUS-ID
Representation of an identity provider
See PROVIDER
See PROVIDER-USERNAME
See PROFILE-URl
See PROOF-URL
See UPDATED-AT
(error "provider required for a identity-proof.")
:provider
(error "provider-username required for a identity-proof.")
:provider-username
(error "profile-url required for a identity-proof.")
:profile-url
(error "proof-url required for a identity-proof.")
:proof-url
(error "updated-at required for a identity-proof.")
:updated-at
Metadata for static images.
See WIDTH
See HEIGHT
See SIZE
See ASPECT
Representation of a Mastodon server instance.
See URI
See TITLE
See DESCRIPTION
See SHORT-DESCRIPTION
See EMAIL
See VERSION
See LANGUAGES
See REGISTRATIONS
See APPROVAL-REQUIRED
See URLS
See STATS
See THUMBNAIL
See CONTACT-ACCOUNT
(setf approval-required)
.
approval-required
.
(setf contact-account)
.
contact-account
.
decode-entity
.
(setf description)
.
description
.
(setf email)
.
email
.
(setf languages)
.
languages
.
print-object
.
(setf registrations)
.
registrations
.
(setf short-description)
.
short-description
.
(setf stats)
.
stats
.
(setf thumbnail)
.
thumbnail
.
(setf title)
.
title
.
(setf uri)
.
uri
.
(setf urls)
.
urls
.
(setf version)
.
version
.
(error "title required for a instance.")
:title
(error "description required for a instance.")
:description
(error "short-description required for a instance.")
:short-description
(error "email required for a instance.")
:email
(error "version required for a instance.")
:version
(error "languages required for a instance.")
:languages
(error "registrations required for a instance.")
:registrations
(error "approval-required required for a instance.")
:approval-required
(error "stats required for a instance.")
:stats
:thumbnail
:contact-account
Representation of statistics about a single instance.
See USER-COUNT
See STATUS-COUNT
See DOMAIN-COUNT
(error "user-count required for a instance-stats.")
:user-count
(error "status-count required for a instance-stats.")
:status-count
(error "domain-count required for a instance-stats.")
:domain-count
Represents a save point in a timeline
See UPDATED-AT
See LAST-READ-ID
SEE VERSION
(error "last-read-id required for a marker.")
:last-read-id
(error "updated-at required for a marker.")
:updated-at
(error "version required for a marker.")
:version
Representation of an account mention in a status.
See URL
See USERNAME
See ACCOUNT-NAME
See ID
(error "username required for a mention.")
:username
(error "account-name required for a mention.")
:account-name
This object holds metadata information for media objects.
See SMALL
See ORIGINAL
See FOCUS
Representation of a new status update notification.
See ID
See KIND
See CREATED-AT
See ACCOUNT
See STATUS
(error "kind required for a notification.")
:kind
kind
.
(error "created-at required for a notification.")
:created-at
(error "account required for a notification.")
:account
:status
Representation of a users poll
See EXPIRES-AT
See EXPIRED
See MULTIPLE
See VOTERS-COUNT
See VOTES-COUNT
See VOTED
See OWN-VOTES
See OPTIONS
See EMOJIS
decode-entity
.
(setf emojis)
.
emojis
.
(setf expired)
.
expired
.
(setf expires-at)
.
expires-at
.
(setf id)
.
id
.
(setf multiple)
.
multiple
.
(setf options)
.
options
.
(setf own-votes)
.
own-votes
.
poll-vote
.
polls
.
print-object
.
(setf voted)
.
voted
.
(setf voters-count)
.
voters-count
.
(setf votes-count)
.
votes-count
.
(error "expires-at required for a poll.")
:expires-at
(error "expired required for a poll.")
:expired
(error "multiple required for a poll.")
:multiple
(error "voters-count required for a poll.")
:voters-count
(error "votes-count required for a poll.")
:votes-count
(error "voted required for a poll.")
:voted
(error "own-votes required for a poll.")
:own-votes
(error "options required for a poll.")
:options
(error "emojis required for a poll.")
:emojis
Representation of a POLL option.
See: TITLE
See: VOTES-COUNT
Representation of the user preferences.
See POSTING-DEFAULT-VISIBILITY
See POSTING-DEFAULT-SENSITIVE
See POSTING-DEFAULT-LANGUAGE
See READING-EXPAND-MEDIA
See READING-EXPAND-SPOILERS
decode-entity
.
(setf posting-default-language)
.
posting-default-language
.
(setf posting-default-sensitive)
.
posting-default-sensitive
.
(setf posting-default-visibility)
.
posting-default-visibility
.
print-object
.
(setf reading-expand-media)
.
reading-expand-media
.
(setf reading-expand-spoilers)
.
reading-expand-spoilers
.
(error "posting-default-visibility required for a preferences.")
:posting-default-visibility
(error "posting-default-sensitive required for a preferences.")
:posting-default-sensitive
:posting-default-language
(error "reading-expand-media required for a preferences.")
:reading-expand-media
(error "reading-expand-spoilers required for a preferences.")
:reading-expand-spoilers
Representation of a push notification subscription.
See ID
See ENDPOINT
See SERVER-KEY
See ALERTS
(error "endpoint required for a push-subscription.")
:endpoint
(error "server-key required for a push-subscription.")
:server-key
:alerts
Representation of alerts for PUSH-SUBSCRIPTION.
See ALERT-FOLLOW
See ALERT-FAVOURITE
See ALERT-MENTION
See ALERT-REBLOG
See ALERT-POLL
(error "alert-follow required for a push-subscription-alerts.")
:alert-follow
(error "alert-favourite required for a push-subscription-alerts.")
:alert-favourite
(error "alert-mention required for a push-subscription-alerts.")
:alert-mention
(error "alert-reblog required for a push-subscription-alerts.")
:alert-reblog
(error "alert-poll required for a push-subscription-alerts.")
:alert-poll
Emoji reaction to a announcement
See ANNOUNCEMENT
See NAME
See REACTION-COUNT
See ME
See URL
See STATIC-URL
(error "reaction-count required for a reaction.")
:reaction-count
:static-url
Representation of a relationship between the current user and another account.
See ID
See FOLLOWING
See REQUESTED
See FOLLOWED-BY
See BLOCKING
See MUTING
See MUTING-NOTIFICATIONS
See SHOWING-REBLOGS
See REQUESTED
See DOMAIN-BLOCKING
See BLOCKED-BY
(setf blocked-by)
.
blocked-by
.
(setf blocking)
.
blocking
.
decode-entity
.
(setf domain-blocking)
.
domain-blocking
.
(setf endorsed)
.
endorsed
.
(setf followed-by)
.
followed-by
.
(setf following)
.
following
.
(setf id)
.
id
.
(setf muting)
.
muting
.
(setf muting-notifications)
.
muting-notifications
.
print-object
.
(setf requested)
.
requested
.
(setf showing-reblogs)
.
showing-reblogs
.
(error "following required for a relationship.")
:following
(error "requested required for a relationship.")
:requested
(error "endorsed required for a relationship.")
:endorsed
(error "followed-by required for a relationship.")
:followed-by
(error "muting required for a relationship.")
:muting
(error "muting-notifications required for a relationship.")
:muting-notifications
(error "showing-reblogs required for a relationship.")
:showing-reblogs
(error "blocking required for a relationship.")
:blocking
(error "domain-blocking required for a relationship.")
:domain-blocking
(error "blocked-by required for a relationship.")
:blocked-by
Representation of an incident report.
See ID
See ACTION-TAKEN
(error "action-taken required for a report.")
:action-taken
Representation of a search result.
See RESULTS-ACCOUNTS
See RESULTS-STATUSES
See HASHTAGS
(error "results-accounts required for a results.")
:results-accounts
(error "results-statuses required for a results.")
:results-statuses
(error "results-tags required for a results.")
:results-tags
Representation of a status programmed to be sent in the future.
See ID
See SCHEDULED-AT
See PARAMS
(error "scheduled-at required for a scheduled-status.")
:scheduled-at
(error "params required for a scheduled-status.")
:params
Representation account preferences
See NOTE
See FIELDS
See PRIVACY
See SENSITIVE
See LANGUAGE
See FOLLOW-REQUESTS-COUNT
(error "fields required for a source.")
:fields
(error "privacy required for a source.")
:privacy
(error "sensitive required for a source.")
:sensitive
(error "language required for a source.")
:language
(error "follow-requests-count required for a source.")
:follow-requests-count
Representation of a status update.
"Statuses", "toots", or "tweets" are the primary content of a
Mastodon instance.
See ID
See URI
See URL
See ACCOUNT
See IN-REPLY-TO-ID
See IN-REPLY-TO-ACCOUNT-ID
See PARENT
See CONTENT
See CREATED-AT
See EMOJIS
See DISCOVERABLE
See REBLOGS-COUNT
See FAVOURITES-COUNT
See REPLIES-COUNT
See REBLOGGED
See FAVOURITED
See MUTED
See SENSITIVE
See SPOILER-TEXT
See VISIBILITY
See MEDIA-ATTACHMENTS
See MENTIONS
See STATUS-TAG
See APPLICATION
See LANGUAGE
See PINNED
See POLL
See PREVIEW-CARD
See BOOKMARKED
(setf account)
.
account
.
(setf application)
.
application
.
bookmark
.
(setf bookmarked)
.
bookmarked
.
card
.
(setf content)
.
content
.
context
.
(setf created-at)
.
created-at
.
decode-entity
.
delete-status
.
describe-object
.
edit-status
.
(setf emojis)
.
emojis
.
favourite
.
(setf favourited)
.
favourited
.
favouriters
.
(setf favourites-count)
.
favourites-count
.
(setf filtered)
.
filtered
.
(setf id)
.
id
.
(setf in-reply-to-account-id)
.
in-reply-to-account-id
.
(setf in-reply-to-id)
.
in-reply-to-id
.
(setf language)
.
language
.
(setf media-attachments)
.
media-attachments
.
(setf mentions)
.
mentions
.
mute
.
mute-conversation
.
(setf muted)
.
muted
.
(setf parent)
.
parent
.
pin
.
(setf pinned)
.
pinned
.
(setf poll)
.
poll
.
present
.
(setf preview-card)
.
preview-card
.
print-object
.
reblog
.
(setf reblogged)
.
reblogged
.
rebloggers
.
(setf reblogs-count)
.
reblogs-count
.
(setf replies-count)
.
replies-count
.
(setf sensitive)
.
sensitive
.
(setf spoiler-text)
.
spoiler-text
.
(setf tags)
.
tags
.
unbookmark
.
unfavourite
.
unmute
.
unmute-conversation
.
unpin
.
unreblog
.
(setf uri)
.
uri
.
(setf url)
.
url
.
(setf visibility)
.
visibility
.
(error "account required for a status.")
:account
:in-reply-to-id
:in-reply-to-account-id
:parent
(error "content required for a status.")
:content
(error "created-at required for a status.")
:created-at
(error "emojis required for a status.")
:emojis
(error "reblogs-count required for a status.")
:reblogs-count
(error "favourites-count required for a status.")
:favourites-count
(error "replies-count required for a status.")
:replies-count
:reblogged
:favourited
:muted
(error "sensitive required for a status.")
:sensitive
(error "spoiler-text required for a status.")
:spoiler-text
(error "visibility required for a status.")
:visibility
(error "media-attachments required for a status.")
:media-attachments
(error "mentions required for a status.")
:mentions
:application
:language
:pinned
:preview-card
(error "bookmarked required for a status.")
:bookmarked
:filtered
Representation of parameters for a SCHEDULED-STATUS.
See SCHEDULED-STATUS
See TEXT
See IN-REPLY-TO-ID
See MEDIA-IDS
See SENSITIVE
See SPOILER-TEXT
See VISIBILITY
See SCHEDULED-AT
See APPLICATION-ID
(error "text required for a status-params.")
:text
text
.
:in-reply-to-id
:media-ids
:sensitive
:spoiler-text
(error "visibility required for a status-params.")
:visibility
:scheduled-at
(error "application-id required for a status-params.")
:application-id
Representation of a tag linked to a status.
SEE NAME
SEE URL
Representation of a hashtag used in a status.
See NAME
See URL
See HISTORY
:history
(error "following required for a tag.")
:following
Representation of the usage history of a hashtag.
See DAY
See USE-COUNT
See ACCOUNT-COUNT
(error "use-count required for a tag-history.")
:use-count
(error "account-count required for a tag-history.")
:account-count
Representation of authorization credentials
See ACCESS-TOKEN
See TOKEN-TYPE
See SCOPE
See CREATED-AT
(error "access-token required for a token.")
:access-token
(error "token-type required for a token.")
:token-type
(error "scope required for a token.")
:scope
(error "created-at required for a token.")
:created-at
Represents a list of users.
See ID
See TITLE
Metadata for animated videos.
See WIDTH
See HEIGHT
See FRAME-RATE
See DURATION
See BITRATE
:width
:height
:frame-rate
:duration
:bitrate
Returns a criteria to sort the emoji.
See EMOJI
Returns Where the filter is applied.
Possible values are:
:HOME — HOME TIMELINE :NOTIFICATIONS — NOTIFICATIONS :PUBLIC — PUBLIC TIMELINE :THREAD — message’s thread
Returns an array of FILTER-KEYWORD of statuses that matched this filter.
See FILTER-KEYWORD
Number of users login for this week
See ACTIVITY
Returns oembed preview.
See CLIENT
request-failed
)) ¶client
) (media attachment
)) ¶Value of the field.
See FIELD
Timestamp when the server verified the URL in the value of this field
See FIELD
Timestamp for the first day of this week stats.
See ACTIVITY
structure-object
.
Representation of statistics about an instance activity.
See WEEK
See STATUSES
See LOGINS
See REGISTRATION
(error "statuses required for a activity.")
:statuses
(error "logins required for a activity.")
:logins
(error "registrations required for a activity.")
:registrations
Represents a profile element as key value pair.
See NAME
See VALUE
See VERIFIED-AT
(error "name required for a field.")
:name
name
.
(error "value required for a field.")
:value
:verified-at
Represents the filter that has been triggered by a status
(error "query-filter required for a filter-results.")
:query-filter
:keyword-matches
:status-matches
Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U V W |
---|
Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U V W |
---|
Jump to: | *
+
A B C D E F H I K L M N O P Q R S T U V W |
---|
Jump to: | *
+
A B C D E F H I K L M N O P Q R S T U V W |
---|
Jump to: | A C D E F I L M N O P Q R S T U V |
---|
Jump to: | A C D E F I L M N O P Q R S T U V |
---|