The tooter Reference Manual

This is the tooter Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:08:34 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 tooter

A client library for Mastodon instances.

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://github.com/Shinmera/tooter

License

zlib

Version

1.0.0

Dependencies
  • com.inuoe.jzon (system).
  • cl-ppcre (system).
  • drakma (system).
  • documentation-utils (system).
Source

tooter.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 tooter/tooter.asd

Source

tooter.asd.

Parent Component

tooter (system).

ASDF Systems

tooter.


3.1.2 tooter/package.lisp

Source

tooter.asd.

Parent Component

tooter (system).

Packages

3.1.3 tooter/toolkit.lisp

Dependency

package.lisp (file).

Source

tooter.asd.

Parent Component

tooter (system).

Public Interface
Internals

3.1.4 tooter/client.lisp

Dependency

toolkit.lisp (file).

Source

tooter.asd.

Parent Component

tooter (system).

Public Interface
Internals

3.1.5 tooter/objects.lisp

Dependency

client.lisp (file).

Source

tooter.asd.

Parent Component

tooter (system).

Public Interface
Internals

3.1.6 tooter/queries.lisp

Dependency

objects.lisp (file).

Source

tooter.asd.

Parent Component

tooter (system).

Public Interface
Internals

3.1.7 tooter/documentation.lisp

Dependency

queries.lisp (file).

Source

tooter.asd.

Parent Component

tooter (system).


4 Packages

Packages are listed by definition order.


4.1 tooter-queries

Source

package.lisp.

Nickname

org.shirakumo.tooter.queries

Use List

tooter-objects.

Used By List

tooter.

Public Interface

4.2 tooter-client

Source

package.lisp.

Nickname

org.shirakumo.tooter.client

Use List

tooter-objects.

Used By List

tooter.

Public Interface

4.3 tooter-objects

Source

package.lisp.

Nickname

org.shirakumo.tooter.objects

Used By List
Public Interface

4.4 tooter

Source

package.lisp.

Nickname

org.shirakumo.tooter

Use List
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Macros

Macro: define-entity (name &body slots)

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))

Package

tooter-objects.

Source

objects.lisp.


5.1.2 Ordinary functions

Function: coerce-boolean (boolean provided)

Converts BOOLEAN to javascript representation, The argument parameter is useful when optional function argument is used like (defun (&optional (delete NIL delete-provided-p)))

Package

tooter-client.

Source

toolkit.lisp.

Function: convert-timestamp (stamp)

Converts STAMP (an integer or string representation of a timestamp into universal timestamp format.

See UNIVERSAL->UTC-TIMESTRING

Package

tooter-client.

Source

toolkit.lisp.

Function: plain-format-html (string)

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.

Package

tooter-client.

Source

toolkit.lisp.

Function: request (uri &key parameters headers method content-type)

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

Package

tooter-client.

Source

client.lisp.

Function: to-keyword (thing)

Converts THING to a lisp keyword

Package

tooter-client.

Source

toolkit.lisp.

Function: universal->utc-timestring (universal)

Converts the output of CL:GET-UNIVERSAL-TIME to a string
representation in ISO8601 format. The string represents the time at UTC timezone.

Package

tooter-client.

Source

toolkit.lisp.


5.1.3 Generic functions

Generic Function: accept-request (client id)

Accept the follow request of the given account.

See ACCOUNT
See CLIENT

Package

tooter-queries.

Methods
Method: accept-request ((client client) (account account))
Source

queries.lisp.

Method: accept-request ((client client) (id string))
Source

queries.lisp.

Generic Reader: access-token (object)

Returns the oauth access token.

See TOKEN

Package

tooter-objects.

Methods
Reader Method: access-token ((token token))

automatically generated reader method

Source

objects.lisp.

Target Slot

access-token.

Reader Method: access-token ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

access-token.

Generic Writer: (setf access-token) (object)
Package

tooter-objects.

Methods
Writer Method: (setf access-token) ((token token))

automatically generated writer method

Source

objects.lisp.

Target Slot

access-token.

Writer Method: (setf access-token) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

access-token.

Generic Reader: account (object)

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

Package

tooter-objects.

Methods
Reader Method: account ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

account.

Reader Method: account ((notification notification))

automatically generated reader method

Source

objects.lisp.

Target Slot

account.

Reader Method: account ((client client))
Source

client.lisp.

Target Slot

account.

Generic Writer: (setf account) (object)
Package

tooter-objects.

Methods
Writer Method: (setf account) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

account.

Writer Method: (setf account) ((notification notification))

automatically generated writer method

Source

objects.lisp.

Target Slot

account.

Writer Method: (setf account) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

account.

Generic Reader: account-count (object)

Returns the number of accounts that made use of the hashtag on that day.

See TAG-HISTORY

Package

tooter-objects.

Methods
Reader Method: account-count ((tag-history tag-history))

automatically generated reader method

Source

objects.lisp.

Target Slot

account-count.

Generic Writer: (setf account-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf account-count) ((tag-history tag-history))

automatically generated writer method

Source

objects.lisp.

Target Slot

account-count.

Generic Function: account-directory (client)

Returns the list of accounts in the public directory .

See CLIENT
See ACCOUNT

Package

tooter-queries.

Methods
Method: account-directory ((client client))
Source

queries.lisp.

Generic Reader: account-name (object)

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

Package

tooter-objects.

Methods
Reader Method: account-name ((mention mention))

automatically generated reader method

Source

objects.lisp.

Target Slot

account-name.

Reader Method: account-name ((announcement-account announcement-account))

automatically generated reader method

Source

objects.lisp.

Target Slot

account-name.

Reader Method: account-name ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

account-name.

Generic Writer: (setf account-name) (object)
Package

tooter-objects.

Methods
Writer Method: (setf account-name) ((mention mention))

automatically generated writer method

Source

objects.lisp.

Target Slot

account-name.

Writer Method: (setf account-name) ((announcement-account announcement-account))

automatically generated writer method

Source

objects.lisp.

Target Slot

account-name.

Writer Method: (setf account-name) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

account-name.

Generic Reader: accounts (object)
Package

tooter-objects.

Methods
Reader Method: accounts ((conversation conversation))

automatically generated reader method

Source

objects.lisp.

Target Slot

accounts.

Generic Writer: (setf accounts) (object)
Package

tooter-objects.

Methods
Writer Method: (setf accounts) ((conversation conversation))

automatically generated writer method

Source

objects.lisp.

Target Slot

accounts.

Generic Reader: action-taken (object)

Returns what kind of action was taken in response to the report.

See REPORT

Package

tooter-objects.

Methods
Reader Method: action-taken ((report report))

automatically generated reader method

Source

objects.lisp.

Target Slot

action-taken.

Generic Writer: (setf action-taken) (object)
Package

tooter-objects.

Methods
Writer Method: (setf action-taken) ((report report))

automatically generated writer method

Source

objects.lisp.

Target Slot

action-taken.

Generic Function: add-reaction-announcement (client id name)

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)

Package

tooter-queries.

Methods
Method: add-reaction-announcement ((client client) (id string) (name string))
Source

queries.lisp.

Generic Function: add-user-list-accounts (client id accounts)

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

Package

tooter-queries.

Methods
Method: add-user-list-accounts ((client client) (user-list user-list) accounts)
Source

queries.lisp.

Method: add-user-list-accounts ((client client) (id string) accounts)
Source

queries.lisp.

Generic Reader: alert-favourite (object)

Returns if get an alert when someone favourite a status posted by the user.

See PUSH-SUBSCRIPTION-ALERTS.

Package

tooter-objects.

Methods
Reader Method: alert-favourite ((push-subscription-alerts push-subscription-alerts))

automatically generated reader method

Source

objects.lisp.

Target Slot

alert-favourite.

Generic Writer: (setf alert-favourite) (object)
Package

tooter-objects.

Methods
Writer Method: (setf alert-favourite) ((push-subscription-alerts push-subscription-alerts))

automatically generated writer method

Source

objects.lisp.

Target Slot

alert-favourite.

Generic Reader: alert-follow (object)

Returns if get an alert when someone follows the user.

See PUSH-SUBSCRIPTION-ALERTS.

Package

tooter-objects.

Methods
Reader Method: alert-follow ((push-subscription-alerts push-subscription-alerts))

automatically generated reader method

Source

objects.lisp.

Target Slot

alert-follow.

Generic Writer: (setf alert-follow) (object)
Package

tooter-objects.

Methods
Writer Method: (setf alert-follow) ((push-subscription-alerts push-subscription-alerts))

automatically generated writer method

Source

objects.lisp.

Target Slot

alert-follow.

Generic Reader: alert-mention (object)

Returns if get an alert when someone mentioned the user.

See PUSH-SUBSCRIPTION-ALERTS.

Package

tooter-objects.

Methods
Reader Method: alert-mention ((push-subscription-alerts push-subscription-alerts))

automatically generated reader method

Source

objects.lisp.

Target Slot

alert-mention.

Generic Writer: (setf alert-mention) (object)
Package

tooter-objects.

Methods
Writer Method: (setf alert-mention) ((push-subscription-alerts push-subscription-alerts))

automatically generated writer method

Source

objects.lisp.

Target Slot

alert-mention.

Generic Reader: alert-poll (object)

Returns if get an alert when a poll the user voted or created has expired.

See POLL
See PUSH-SUBSCRIPTION-ALERTS.

Package

tooter-objects.

Methods
Reader Method: alert-poll ((push-subscription-alerts push-subscription-alerts))

automatically generated reader method

Source

objects.lisp.

Target Slot

alert-poll.

Generic Writer: (setf alert-poll) (object)
Package

tooter-objects.

Methods
Writer Method: (setf alert-poll) ((push-subscription-alerts push-subscription-alerts))

automatically generated writer method

Source

objects.lisp.

Target Slot

alert-poll.

Generic Reader: alert-reblog (object)

Returns if get an alert when someone boosted a status posted by the user.

See PUSH-SUBSCRIPTION-ALERTS.

Package

tooter-objects.

Methods
Reader Method: alert-reblog ((push-subscription-alerts push-subscription-alerts))

automatically generated reader method

Source

objects.lisp.

Target Slot

alert-reblog.

Generic Writer: (setf alert-reblog) (object)
Package

tooter-objects.

Methods
Writer Method: (setf alert-reblog) ((push-subscription-alerts push-subscription-alerts))

automatically generated writer method

Source

objects.lisp.

Target Slot

alert-reblog.

Generic Reader: alerts (object)

What kinds of alerts push notifications are being sent out for... I think.

See PUSH-SUBSCRIPTION

Package

tooter-objects.

Methods
Reader Method: alerts ((push-subscription push-subscription))

automatically generated reader method

Source

objects.lisp.

Target Slot

alerts.

Generic Writer: (setf alerts) (object)
Package

tooter-objects.

Methods
Writer Method: (setf alerts) ((push-subscription push-subscription))

automatically generated writer method

Source

objects.lisp.

Target Slot

alerts.

Generic Reader: all-day (object)

Returns if this announcement starts or ends on date, not daytime.

See ANNOUNCEMENT

Package

tooter-objects.

Methods
Reader Method: all-day ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

all-day.

Generic Writer: (setf all-day) (object)
Package

tooter-objects.

Methods
Writer Method: (setf all-day) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

all-day.

Generic Reader: ancestors (object)

Returns the list of ancestor status instances in the context chain.

See CONTEXT

Package

tooter-objects.

Methods
Reader Method: ancestors ((context context))

automatically generated reader method

Source

objects.lisp.

Target Slot

ancestors.

Generic Writer: (setf ancestors) (object)
Package

tooter-objects.

Methods
Writer Method: (setf ancestors) ((context context))

automatically generated writer method

Source

objects.lisp.

Target Slot

ancestors.

Generic Reader: application (object)

Returns the application with which this status was made.

See STATUS
See APPLICATION

Package

tooter-objects.

Methods
Reader Method: application ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

application.

Generic Writer: (setf application) (object)
Package

tooter-objects.

Methods
Writer Method: (setf application) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

application.

Generic Reader: application-id (object)

WIP

See status-params

Package

tooter-objects.

Methods
Reader Method: application-id ((status-params status-params))

automatically generated reader method

Source

objects.lisp.

Target Slot

application-id.

Generic Writer: (setf application-id) (object)
Package

tooter-objects.

Methods
Writer Method: (setf application-id) ((status-params status-params))

automatically generated writer method

Source

objects.lisp.

Target Slot

application-id.

Generic Reader: approval-required (object)

Returns if approval from moderator is required to register to this instance.

See INSTANCE

Package

tooter-objects.

Methods
Reader Method: approval-required ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

approval-required.

Generic Writer: (setf approval-required) (object)
Package

tooter-objects.

Methods
Writer Method: (setf approval-required) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

approval-required.

Generic Reader: aspect (object)

Returns the aspect ratio of the image.

See IMAGE-METADATA

Package

tooter-objects.

Methods
Reader Method: aspect ((image-metadata image-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

aspect.

Generic Writer: (setf aspect) (object)
Package

tooter-objects.

Methods
Writer Method: (setf aspect) ((image-metadata image-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

aspect.

Generic Reader: audio-bitrate (object)

Returns the audio bitrate.

See AUDIO-METADATA

Package

tooter-objects.

Methods
Reader Method: audio-bitrate ((audio-metadata audio-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

audio-bitrate.

Generic Writer: (setf audio-bitrate) (object)
Package

tooter-objects.

Methods
Writer Method: (setf audio-bitrate) ((audio-metadata audio-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

audio-bitrate.

Generic Reader: audio-channels (object)

Returns the audio channels.

See AUDIO-METADATA

Package

tooter-objects.

Methods
Reader Method: audio-channels ((audio-metadata audio-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

audio-channels.

Generic Writer: (setf audio-channels) (object)
Package

tooter-objects.

Methods
Writer Method: (setf audio-channels) ((audio-metadata audio-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

audio-channels.

Generic Reader: audio-encode (object)

Returns the audio encoding (mp3, ogg etch.).

See AUDIO-METADATA

Package

tooter-objects.

Methods
Reader Method: audio-encode ((audio-metadata audio-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

audio-encode.

Generic Writer: (setf audio-encode) (object)
Package

tooter-objects.

Methods
Writer Method: (setf audio-encode) ((audio-metadata audio-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

audio-encode.

Generic Reader: audio-length (object)

Returns the length (time) of the audio.

See AUDIO-METADATA

Package

tooter-objects.

Methods
Reader Method: audio-length ((audio-metadata audio-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

audio-length.

Generic Writer: (setf audio-length) (object)
Package

tooter-objects.

Methods
Writer Method: (setf audio-length) ((audio-metadata audio-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

audio-length.

Generic Reader: author-name (object)

Returns the name of the status’ author.

See CARD

Package

tooter-objects.

Methods
Reader Method: author-name ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

author-name.

Generic Writer: (setf author-name) (object)
Package

tooter-objects.

Methods
Writer Method: (setf author-name) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

author-name.

Generic Reader: author-url (object)

Returns the URL to the status’ author’s profile.

See CARD

Package

tooter-objects.

Methods
Reader Method: author-url ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

author-url.

Generic Writer: (setf author-url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf author-url) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

author-url.

Generic Function: authorize (client &optional authorization-code)

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

Package

tooter-client.

Methods
Method: authorize ((client client) &optional authorization-code)
Source

client.lisp.

Generic Reader: avatar (object)

Returns the full URL to the account’s avatar image.

This may be an animated image.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: avatar ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

avatar.

Generic Writer: (setf avatar) (object)
Package

tooter-objects.

Methods
Writer Method: (setf avatar) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

avatar.

Generic Reader: avatar-static (object)

Returns the full URL to the account’s static avatar image.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: avatar-static ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

avatar-static.

Generic Writer: (setf avatar-static) (object)
Package

tooter-objects.

Methods
Writer Method: (setf avatar-static) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

avatar-static.

Generic Reader: base (object)

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

Package

tooter-client.

Methods
Reader Method: base ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

base.

Generic Writer: (setf base) (object)
Package

tooter-client.

Methods
Writer Method: (setf base) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

base.

Generic Reader: bitrate (object)

Returns the bitrate of the video in ???.

See VIDEO-METADATA

Package

tooter-objects.

Methods
Reader Method: bitrate ((video-metadata video-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

bitrate.

Generic Writer: (setf bitrate) (object)
Package

tooter-objects.

Methods
Writer Method: (setf bitrate) ((video-metadata video-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

bitrate.

Generic Function: block (client id)

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

Package

tooter-queries.

Methods
Method: block ((client client) (domain string))
Source

queries.lisp.

Method: block ((client client) (account account))
Source

queries.lisp.

Generic Reader: blocked-by (object)

Returns if this user has blocking you.

See RELATIONSHIP

Package

tooter-objects.

Methods
Reader Method: blocked-by ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

blocked-by.

Generic Writer: (setf blocked-by) (object)
Package

tooter-objects.

Methods
Writer Method: (setf blocked-by) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

blocked-by.

Generic Function: blocked-domains (client &key max-id since-id limit)

Retrieve a list of blocked domains.

See CLIENT

Package

tooter-queries.

Methods
Method: blocked-domains ((client client) &key max-id since-id limit)
Source

queries.lisp.

Generic Reader: blocking (object)

Returns whether the account is blocked by you.

See RELATIONSHIP

Package

tooter-objects.

Methods
Reader Method: blocking ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

blocking.

Generic Writer: (setf blocking) (object)
Package

tooter-objects.

Methods
Writer Method: (setf blocking) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

blocking.

Generic Function: blocks (client &key max-id since-id limit)

Retrieve a list of blocked accounts.

See CLIENT
See ACCOUNT

Package

tooter-queries.

Methods
Method: blocks ((client client) &key max-id since-id limit)
Source

queries.lisp.

Generic Reader: blurhash (object)
Package

tooter-objects.

Methods
Reader Method: blurhash ((attachment attachment))

automatically generated reader method

Source

objects.lisp.

Target Slot

blurhash.

Generic Writer: (setf blurhash) (object)
Package

tooter-objects.

Methods
Writer Method: (setf blurhash) ((attachment attachment))

automatically generated writer method

Source

objects.lisp.

Target Slot

blurhash.

Generic Function: bookmark (client id)

Add a STATUS to user’s bookmark.

See CLIENT
See STATUS

Package

tooter-queries.

Methods
Method: bookmark ((client client) (status status))
Source

queries.lisp.

Method: bookmark ((client client) (id string))
Source

queries.lisp.

Generic Reader: bookmarked (object)

Returns whether this status has been bookmarked from the user.

See STATUS

Package

tooter-objects.

Methods
Reader Method: bookmarked ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

bookmarked.

Generic Writer: (setf bookmarked) (object)
Package

tooter-objects.

Methods
Writer Method: (setf bookmarked) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

bookmarked.

Generic Function: bookmarks (client &key max-id since-id min-id limit)

Returns a list of STATUS bookmarked by the user.

See CLIENT
See STATUS

Package

tooter-queries.

Methods
Method: bookmarks ((client client) &key max-id since-id min-id limit)
Source

queries.lisp.

Generic Reader: bot (object)

Returns whether the account is a bot.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: bot ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

bot.

Generic Writer: (setf bot) (object)
Package

tooter-objects.

Methods
Writer Method: (setf bot) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

bot.

Generic Function: card (client id)

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

Package

tooter-objects.

Methods
Method: card ((client client) (status status))
Source

queries.lisp.

Method: card ((client client) (id string))
Source

queries.lisp.

Generic Reader: code (condition)

Returns the HTTP return code for the failed request.

See REQUEST-FAILED

Package

tooter-client.

Methods
Reader Method: code ((condition request-failed))
Source

client.lisp.

Target Slot

code.

Generic Reader: contact-account (object)

Returns the account instance that represents the contact person for this instance.

See INSTANCE

Package

tooter-objects.

Methods
Reader Method: contact-account ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

contact-account.

Generic Writer: (setf contact-account) (object)
Package

tooter-objects.

Methods
Writer Method: (setf contact-account) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

contact-account.

Generic Reader: content (object)

Returns the status’ content as an HTML string.

See STATUS

Package

tooter-objects.

Methods
Reader Method: content ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

content.

Reader Method: content ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

content.

Generic Writer: (setf content) (object)
Package

tooter-objects.

Methods
Writer Method: (setf content) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

content.

Writer Method: (setf content) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

content.

Generic Function: context (client id)

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

Package

tooter-objects.

Methods
Method: context ((client client) (status status))
Source

queries.lisp.

Method: context ((client client) (id string))
Source

queries.lisp.

Generic Function: conversations (client &key limit max-id since-id min-id)

Returns a list of conversation.

See CONVERSATION
See CLIENT

Package

tooter-objects.

Source

queries.lisp.

Methods
Method: conversations ((client client) &key limit max-id since-id min-id)
Generic Function: create-filter (client phrase context &key irreversible whole-word expires-in)

Create a new filter.

See CLIENT
See FILTER

Package

tooter-queries.

Methods
Method: create-filter ((client client) phrase context &key irreversible whole-word expires-in)
Source

queries.lisp.

Generic Reader: created-at (object)

Returns the time when the token was created.

See TOKEN

Package

tooter-objects.

Methods
Reader Method: created-at ((token token))

automatically generated reader method

Source

objects.lisp.

Target Slot

created-at.

Reader Method: created-at ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

created-at.

Reader Method: created-at ((notification notification))

automatically generated reader method

Source

objects.lisp.

Target Slot

created-at.

Reader Method: created-at ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

created-at.

Generic Writer: (setf created-at) (object)
Package

tooter-objects.

Methods
Writer Method: (setf created-at) ((token token))

automatically generated writer method

Source

objects.lisp.

Target Slot

created-at.

Writer Method: (setf created-at) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

created-at.

Writer Method: (setf created-at) ((notification notification))

automatically generated writer method

Source

objects.lisp.

Target Slot

created-at.

Writer Method: (setf created-at) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

created-at.

Generic Reader: data (condition)

Returns the data payload for the failed request as parsed JSON.

See REQUEST-FAILED

Package

tooter-client.

Methods
Reader Method: data ((condition request-failed))
Source

client.lisp.

Target Slot

data.

Generic Reader: day (object)

Returns the universal-time of the day for which this usage history is.

See TAG-HISTORY

Package

tooter-objects.

Methods
Reader Method: day ((tag-history tag-history))

automatically generated reader method

Source

objects.lisp.

Target Slot

day.

Generic Writer: (setf day) (object)
Package

tooter-objects.

Methods
Writer Method: (setf day) ((tag-history tag-history))

automatically generated writer method

Source

objects.lisp.

Target Slot

day.

Generic Function: decode-entity (type data)

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.

Package

tooter-objects.

Source

objects.lisp.

Methods
Method: decode-entity ((token token) data0)
Method: decode-entity ((identity-proof identity-proof) data0)
Method: decode-entity ((filter filter) data0)
Method: decode-entity ((featured-tag featured-tag) data0)
Method: decode-entity ((conversation conversation) data0)
Method: decode-entity ((tag-history tag-history) data0)
Method: decode-entity ((tag tag) data0)
Method: decode-entity ((source source) data0)
Method: decode-entity ((status status) data0)
Method: decode-entity ((scheduled-status scheduled-status) data0)
Method: decode-entity ((status-params status-params) data0)
Method: decode-entity ((results results) data0)
Method: decode-entity ((report report) data0)
Method: decode-entity ((relationship relationship) data0)
Method: decode-entity ((reaction reaction) data0)
Method: decode-entity ((push-subscription push-subscription) data0)
Method: decode-entity ((push-subscription-alerts push-subscription-alerts) data0)
Method: decode-entity ((preferences preferences) data0)
Method: decode-entity ((poll poll) data0)
Method: decode-entity ((poll-option poll-option) data0)
Method: decode-entity ((notification notification) data0)
Method: decode-entity ((mention mention) data0)
Method: decode-entity ((marker marker) data0)
Method: decode-entity ((user-list user-list) data0)
Method: decode-entity ((instance instance) data0)
Method: decode-entity ((instance-stats instance-stats) data0)
Method: decode-entity ((emoji emoji) data0)
Method: decode-entity ((context context) data0)
Method: decode-entity ((card card) data0)
Method: decode-entity ((audio-metadata audio-metadata) data0)
Method: decode-entity ((video-metadata video-metadata) data0)
Method: decode-entity ((image-metadata image-metadata) data0)
Method: decode-entity ((metadata metadata) data0)
Method: decode-entity ((attachment attachment) data0)
Method: decode-entity ((application application) data0)
Method: decode-entity ((announcement announcement) data0)
Method: decode-entity ((announcement-status announcement-status) data0)
Method: decode-entity ((announcement-account announcement-account) data0)
Method: decode-entity ((activity activity) data0)
Method: decode-entity ((account account) data0)
Method: decode-entity ((field field) data0)
Method: decode-entity ((type symbol) (data list))
Method: decode-entity ((type symbol) data)
Generic Function: default-headers (client &key idempotency-key)

Returns additional headers to be sent with requests from the client.

See CLIENT

Package

tooter-client.

Methods
Method: default-headers ((client client) &key idempotency-key)
Source

client.lisp.

Generic Function: delete-conversation (client id)

Deletes a conversation.

See CONVERSATION See CLIENT

Package

tooter-queries.

Methods
Method: delete-conversation ((client client) (id string))
Source

queries.lisp.

Generic Function: delete-filter (client id)

Delete an existing filter.

See CLIENT
See FILTER

Package

tooter-queries.

Methods
Method: delete-filter ((client client) id)
Source

queries.lisp.

Generic Function: delete-notification (client all)

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

Package

tooter-queries.

Methods
Method: delete-notification ((client client) (notification notification))
Source

queries.lisp.

Method: delete-notification ((client client) (id string))
Source

queries.lisp.

Method: delete-notification ((client client) (all (eql t)))
Source

queries.lisp.

Generic Function: delete-status (client id)

Delete the given status.

The status can either be a STATUS instance, or an ID of one.

Returns T.

See STATUS
See CLIENT

Package

tooter-queries.

Methods
Method: delete-status ((client client) (status status))
Source

queries.lisp.

Method: delete-status ((client client) (id string))
Source

queries.lisp.

Generic Function: delete-subscription (client)

Delete the existing push subscription.

Returns T.

See CLIENT

Package

tooter-queries.

Methods
Method: delete-subscription ((client client))
Source

queries.lisp.

Generic Function: delete-user-list (client id)

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

Package

tooter-queries.

Methods
Method: delete-user-list ((client client) (id string))
Source

queries.lisp.

Generic Reader: descendants (object)

Returns the list of descendant status instances in the context chain.

See CONTEXT

Package

tooter-objects.

Methods
Reader Method: descendants ((context context))

automatically generated reader method

Source

objects.lisp.

Target Slot

descendants.

Generic Writer: (setf descendants) (object)
Package

tooter-objects.

Methods
Writer Method: (setf descendants) ((context context))

automatically generated writer method

Source

objects.lisp.

Target Slot

descendants.

Generic Reader: description (object)

Returns the hash of the attachment as computed by blurhash algorithm. This is actually a very small preview of the attachment

See ATTACHMENT

Package

tooter-objects.

Methods
Reader Method: description ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

description.

Reader Method: description ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

description.

Reader Method: description ((attachment attachment))

automatically generated reader method

Source

objects.lisp.

Target Slot

description.

Generic Writer: (setf description) (object)
Package

tooter-objects.

Methods
Writer Method: (setf description) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

description.

Writer Method: (setf description) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

description.

Writer Method: (setf description) ((attachment attachment))

automatically generated writer method

Source

objects.lisp.

Target Slot

description.

Generic Reader: discoverable (object)

Returns non nil if the status could be displayed in a public directory of the instance.

See STATUS

Package

tooter-objects.

Methods
Reader Method: discoverable ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

discoverable.

Generic Writer: (setf discoverable) (object)
Package

tooter-objects.

Methods
Writer Method: (setf discoverable) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

discoverable.

Generic Function: dismiss-announcement (client id)

Get the administrator’s announcements See ANNOUNCEMENT

The arguments should be seen as follows: ID — the announce’s ID

Package

tooter-queries.

Methods
Method: dismiss-announcement ((client client) (id string))
Source

queries.lisp.

Generic Function: dismiss-reaction-announcement (client id name)

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)

Package

tooter-queries.

Methods
Method: dismiss-reaction-announcement ((client client) (id string) (name string))
Source

queries.lisp.

Generic Reader: display-name (object)

Returns the display name of the account.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: display-name ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

display-name.

Generic Writer: (setf display-name) (object)
Package

tooter-objects.

Methods
Writer Method: (setf display-name) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

display-name.

Generic Reader: domain-blocking (object)

Returns whether you are blocking the account’s domain.

See RELATIONSHIP

Package

tooter-objects.

Methods
Reader Method: domain-blocking ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

domain-blocking.

Generic Writer: (setf domain-blocking) (object)
Package

tooter-objects.

Methods
Writer Method: (setf domain-blocking) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

domain-blocking.

Generic Reader: domain-count (object)

Returns the count of domains this instance is federated with.

See INSTANCE-STATS

Package

tooter-objects.

Methods
Reader Method: domain-count ((instance-stats instance-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

domain-count.

Generic Writer: (setf domain-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf domain-count) ((instance-stats instance-stats))

automatically generated writer method

Source

objects.lisp.

Target Slot

domain-count.

Generic Reader: duration (object)

Returns the duration of the video in seconds.

See VIDEO-METADATA

Package

tooter-objects.

Methods
Reader Method: duration ((audio-metadata audio-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

duration.

Reader Method: duration ((video-metadata video-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

duration.

Generic Writer: (setf duration) (object)
Package

tooter-objects.

Methods
Writer Method: (setf duration) ((audio-metadata audio-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

duration.

Writer Method: (setf duration) ((video-metadata video-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

duration.

Generic Reader: email (object)

Returns the primary contact email address for the instance.

See INSTANCE

Package

tooter-objects.

Methods
Reader Method: email ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

email.

Generic Writer: (setf email) (object)
Package

tooter-objects.

Methods
Writer Method: (setf email) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

email.

Generic Reader: embed-url (object)

photo embedding (URL)

See CARD

Package

tooter-objects.

Methods
Reader Method: embed-url ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

embed-url.

Generic Writer: (setf embed-url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf embed-url) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

embed-url.

Generic Function: emojis (object)

Retrieve a list of custom emojis present on the instance.

See CLIENT
See EMOJI

Package

tooter-objects.

Methods
Method: emojis ((client client))
Source

queries.lisp.

Reader Method: emojis ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

emojis.

Reader Method: emojis ((poll poll))

automatically generated reader method

Source

objects.lisp.

Target Slot

emojis.

Reader Method: emojis ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

emojis.

Reader Method: emojis ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

emojis.

Generic Writer: (setf emojis) (object)
Package

tooter-objects.

Methods
Writer Method: (setf emojis) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

emojis.

Writer Method: (setf emojis) ((poll poll))

automatically generated writer method

Source

objects.lisp.

Target Slot

emojis.

Writer Method: (setf emojis) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

emojis.

Writer Method: (setf emojis) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

emojis.

Generic Reader: endorsed (object)
Package

tooter-objects.

Methods
Reader Method: endorsed ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

endorsed.

Generic Writer: (setf endorsed) (object)
Package

tooter-objects.

Methods
Writer Method: (setf endorsed) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

endorsed.

Generic Function: endorsements (client)

Returns the accounts an user is showing in their profile.

See CLIENT
See PIN
See UNPIN

Package

tooter-queries.

Methods
Method: endorsements ((client client))
Source

queries.lisp.

Generic Reader: endpoint (object)

The endpoint URL to which push notifications are delivered.

See PUSH-SUBSCRIPTION

Package

tooter-objects.

Methods
Reader Method: endpoint ((push-subscription push-subscription))

automatically generated reader method

Source

objects.lisp.

Target Slot

endpoint.

Generic Writer: (setf endpoint) (object)
Package

tooter-objects.

Methods
Writer Method: (setf endpoint) ((push-subscription push-subscription))

automatically generated writer method

Source

objects.lisp.

Target Slot

endpoint.

Generic Reader: ends-at (object)

Returns a date when announcement will end.

See ANNOUNCEMENT

Package

tooter-objects.

Methods
Reader Method: ends-at ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

ends-at.

Generic Writer: (setf ends-at) (object)
Package

tooter-objects.

Methods
Writer Method: (setf ends-at) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

ends-at.

Generic Function: ensure-integer (object)

Converts OBJECT to an integer

Package

tooter-client.

Source

toolkit.lisp.

Methods
Method: ensure-integer ((object string))
Method: ensure-integer ((object integer))
Generic Reader: expired (object)

Returns if the poll has expired

See POLL

Package

tooter-objects.

Methods
Reader Method: expired ((poll poll))

automatically generated reader method

Source

objects.lisp.

Target Slot

expired.

Generic Writer: (setf expired) (object)
Package

tooter-objects.

Methods
Writer Method: (setf expired) ((poll poll))

automatically generated writer method

Source

objects.lisp.

Target Slot

expired.

Generic Reader: expires-at (object)

Returns the expiration date of the filter

See FILTER

Package

tooter-objects.

Methods
Reader Method: expires-at ((filter filter))

automatically generated reader method

Source

objects.lisp.

Target Slot

expires-at.

Reader Method: expires-at ((poll poll))

automatically generated reader method

Source

objects.lisp.

Target Slot

expires-at.

Generic Writer: (setf expires-at) (object)
Package

tooter-objects.

Methods
Writer Method: (setf expires-at) ((filter filter))

automatically generated writer method

Source

objects.lisp.

Target Slot

expires-at.

Writer Method: (setf expires-at) ((poll poll))

automatically generated writer method

Source

objects.lisp.

Target Slot

expires-at.

Generic Function: favourite (client id)

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

Package

tooter-queries.

Methods
Method: favourite ((client client) (status status))
Source

queries.lisp.

Method: favourite ((client client) (id string))
Source

queries.lisp.

Generic Reader: favourited (object)

Returns whether you have favourited this status.

See STATUS

Package

tooter-objects.

Methods
Reader Method: favourited ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

favourited.

Generic Writer: (setf favourited) (object)
Package

tooter-objects.

Methods
Writer Method: (setf favourited) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

favourited.

Generic Function: favouriters (client id &key max-id since-id limit)

Retrieve the list of accounts that favourited the status.

The status can either be a STATUS instance, or an ID of one.

See STATUS
See CLIENT
See ACCOUNT

Package

tooter-queries.

Methods
Method: favouriters ((client client) (status status) &rest args)
Source

queries.lisp.

Method: favouriters ((client client) (id string) &key max-id since-id limit)
Source

queries.lisp.

Generic Function: favourites (client &key min-id max-id limit)

Retrieve a list of favourited statuses.

See CLIENT
See STATUS

Package

tooter-queries.

Methods
Method: favourites ((client client) &key min-id max-id limit)
Source

queries.lisp.

Generic Reader: favourites-count (object)

Returns the number of favourites this status has received.

See STATUS

Package

tooter-objects.

Methods
Reader Method: favourites-count ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

favourites-count.

Generic Writer: (setf favourites-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf favourites-count) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

favourites-count.

Generic Reader: fields (object)

Returns the user metadata.

See SOURCE

Package

tooter-objects.

Methods
Reader Method: fields ((source source))

automatically generated reader method

Source

objects.lisp.

Target Slot

fields.

Reader Method: fields ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

fields.

Generic Writer: (setf fields) (object)
Package

tooter-objects.

Methods
Writer Method: (setf fields) ((source source))

automatically generated writer method

Source

objects.lisp.

Target Slot

fields.

Writer Method: (setf fields) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

fields.

Generic Function: filter (client id)

Return a filter for this user.

See CLIENT
See FILTER

Package

tooter-objects.

Methods
Method: filter ((client client) (filter filter))
Source

queries.lisp.

Method: filter ((client client) (id string))
Source

queries.lisp.

Generic Function: filters (client)

Returns a list of all filters for this user.

See CLIENT
See FILTER

Package

tooter-queries.

Methods
Method: filters ((client client))
Source

queries.lisp.

Generic Function: find-account (client id)

Find an account with the specified ID.

This only works for accounts that are local to the instance.

See CLIENT
See ACCOUNT

Package

tooter-queries.

Methods
Method: find-account ((client client) (id string))
Source

queries.lisp.

Generic Function: find-list (client id)

Retrieve the user list with the given ID.

See USER-LIST
See CLIENT

Package

tooter-queries.

Methods
Method: find-list ((client client) (id string))
Source

queries.lisp.

Generic Function: find-notification (client id)

Retrieve the notification of the given ID.

See NOTIFICATION
See CLIENT

Package

tooter-queries.

Methods
Method: find-notification ((client client) (id string))
Source

queries.lisp.

Generic Function: find-results (client query &key account-id max-id min-id kind exclude-unreviewed resolve limit offset following)

Search the Mastodon instance for matching tags, accounts, or statuses.

See RESULTS
See CLIENT

Package

tooter-queries.

Methods
Method: find-results ((client client) query &key account-id max-id min-id kind exclude-unreviewed resolve limit offset following)
Source

queries.lisp.

Generic Function: find-status (client id)

Retrieve the status with the given ID.

See CLIENT
See STATUS

Package

tooter-queries.

Methods
Method: find-status ((client client) (id string))
Source

queries.lisp.

Generic Reader: focus (object)

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

Package

tooter-objects.

Methods
Reader Method: focus ((metadata metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

focus.

Generic Writer: (setf focus) (object)
Package

tooter-objects.

Methods
Writer Method: (setf focus) ((metadata metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

focus.

Generic Function: follow (client id)

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

Package

tooter-queries.

Methods
Method: follow ((client client) (account account))
Source

queries.lisp.

Method: follow ((client client) (id string))
Source

queries.lisp.

Generic Function: follow-requests (client &key max-id since-id limit)

Retrieve a list of accounts that requested to follow you.

See ACCOUNT
See CLIENT

Package

tooter-queries.

Methods
Method: follow-requests ((client client) &key max-id since-id limit)
Source

queries.lisp.

Generic Reader: follow-requests-count (object)

Returns the number of follow requests.

See SOURCE

Package

tooter-objects.

Methods
Reader Method: follow-requests-count ((source source))

automatically generated reader method

Source

objects.lisp.

Target Slot

follow-requests-count.

Generic Writer: (setf follow-requests-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf follow-requests-count) ((source source))

automatically generated writer method

Source

objects.lisp.

Target Slot

follow-requests-count.

Generic Function: follow-tag (client tag)

Follow a tag.

See CLIENT See TAG

Package

tooter-queries.

Source

queries.lisp.

Methods
Method: follow-tag ((client client) (tag tag))
Method: follow-tag ((client client) (tag string))
Generic Reader: followed-by (object)

Returns whether the account is following you.

See RELATIONSHIP

Package

tooter-objects.

Methods
Reader Method: followed-by ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

followed-by.

Generic Writer: (setf followed-by) (object)
Package

tooter-objects.

Methods
Writer Method: (setf followed-by) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

followed-by.

Generic Function: followed-tags (client &key max-id since-id min-id limit)

Returns a list of followed tags.

See CLIENT
See TAG

Package

tooter-queries.

Source

queries.lisp.

Methods
Method: followed-tags ((client client) &key max-id since-id min-id limit)
Generic Reader: followers-count (object)

Returns the number of followers the account has.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: followers-count ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

followers-count.

Generic Writer: (setf followers-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf followers-count) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

followers-count.

Generic Reader: following (object)

Returns whether you are following this account.

See RELATIONSHIP

Package

tooter-objects.

Methods
Reader Method: following ((tag tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

following.

Reader Method: following ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

following.

Generic Writer: (setf following) (object)
Package

tooter-objects.

Methods
Writer Method: (setf following) ((tag tag))

automatically generated writer method

Source

objects.lisp.

Target Slot

following.

Writer Method: (setf following) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

following.

Generic Reader: following-count (object)

Returns the number of users this account is following.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: following-count ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

following-count.

Generic Writer: (setf following-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf following-count) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

following-count.

Generic Reader: frame-rate (object)

Returns the frame-rate of the video in FPS.

See VIDEO-METADATA

Package

tooter-objects.

Methods
Reader Method: frame-rate ((video-metadata video-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

frame-rate.

Generic Writer: (setf frame-rate) (object)
Package

tooter-objects.

Methods
Writer Method: (setf frame-rate) ((video-metadata video-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

frame-rate.

Generic Function: get-activity (client)

Get statistics from an instance

See CLIENT
See ACTIVITY

Package

tooter-queries.

Methods
Method: get-activity ((client client))
Source

queries.lisp.

Generic Function: get-announcements (client &key with-dismissed)

Get the administrator’s announcements
See ANNOUNCEMENT

The argument should be seen as follows:
WITH-DISMISSED — Get the dismissed announcements too (default: NIL)

Package

tooter-queries.

Methods
Method: get-announcements ((client client) &key with-dismissed)
Source

queries.lisp.

Generic Function: get-followers (client id &key max-id since-id limit)

Returns a list of followers for the account.

The account can be an ACCOUNT instance, an account ID, or T for yourself.

See CLIENT
See ACCOUNT

Package

tooter-queries.

Methods
Method: get-followers ((client client) (self (eql t)) &rest args)
Source

queries.lisp.

Method: get-followers ((client client) (account account) &rest args)
Source

queries.lisp.

Method: get-followers ((client client) (id string) &key max-id since-id limit)
Source

queries.lisp.

Generic Function: get-following (client id &key max-id since-id limit)

Returns a list of accounts the account is following.

The account can be an ACCOUNT instance, an account ID, or T for yourself.

See CLIENT
See ACCOUNT

Package

tooter-queries.

Methods
Method: get-following ((client client) (self (eql t)) &rest args)
Source

queries.lisp.

Method: get-following ((client client) (account account) &rest args)
Source

queries.lisp.

Method: get-following ((client client) (id string) &key max-id since-id limit)
Source

queries.lisp.

Generic Function: get-statuses (client id &key only-media pinned exclude-replies max-id since-id limit)

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

Package

tooter-queries.

Methods
Method: get-statuses ((client client) (self (eql t)) &rest args)
Source

queries.lisp.

Method: get-statuses ((client client) (account account) &rest args)
Source

queries.lisp.

Method: get-statuses ((client client) (id string) &key only-media pinned exclude-replies max-id since-id limit)
Source

queries.lisp.

Generic Reader: hashtags (object)

Returns a list of matching hashtags as strings.

See RESULTS

Package

tooter-objects.

Methods
Reader Method: hashtags ((results results))

automatically generated reader method

Source

objects.lisp.

Target Slot

hashtags.

Generic Writer: (setf hashtags) (object)
Package

tooter-objects.

Methods
Writer Method: (setf hashtags) ((results results))

automatically generated writer method

Source

objects.lisp.

Target Slot

hashtags.

Generic Reader: header (object)

Returns the full URL to the account’s header image.

This may be an animated image.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: header ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

header.

Generic Writer: (setf header) (object)
Package

tooter-objects.

Methods
Writer Method: (setf header) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

header.

Generic Reader: header-static (object)

Returns the full URL to the account’s static header image.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: header-static ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

header-static.

Generic Writer: (setf header-static) (object)
Package

tooter-objects.

Methods
Writer Method: (setf header-static) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

header-static.

Generic Reader: height (object)

Returns the height of the media or card.

See CARD
See IMAGE-METADATA
See VIDEO-METADATA

Package

tooter-objects.

Methods
Reader Method: height ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

height.

Reader Method: height ((video-metadata video-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

height.

Reader Method: height ((image-metadata image-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

height.

Generic Writer: (setf height) (object)
Package

tooter-objects.

Methods
Writer Method: (setf height) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

height.

Writer Method: (setf height) ((video-metadata video-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

height.

Writer Method: (setf height) ((image-metadata image-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

height.

Generic Reader: history (object)

Returns an array describing daily usage information of the hashtag.

See TAG
See TAG-HISTORY

Package

tooter-objects.

Methods
Reader Method: history ((tag tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

history.

Generic Writer: (setf history) (object)
Package

tooter-objects.

Methods
Writer Method: (setf history) ((tag tag))

automatically generated writer method

Source

objects.lisp.

Target Slot

history.

Generic Reader: html (object)

Returns an HTML snippet for the card’s OEmbed data.

See CARD

Package

tooter-objects.

Methods
Reader Method: html ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

html.

Generic Writer: (setf html) (object)
Package

tooter-objects.

Methods
Writer Method: (setf html) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

html.

Generic Reader: id (object)

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

Package

tooter-objects.

Methods
Reader Method: id ((filter filter))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((featured-tag featured-tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((conversation conversation))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((scheduled-status scheduled-status))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((report report))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((push-subscription push-subscription))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((poll poll))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((notification notification))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((mention mention))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((user-list user-list))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((attachment attachment))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((announcement-status announcement-status))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((announcement-account announcement-account))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Reader Method: id ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

id.

Generic Writer: (setf id) (object)
Package

tooter-objects.

Methods
Writer Method: (setf id) ((filter filter))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((featured-tag featured-tag))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((conversation conversation))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((scheduled-status scheduled-status))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((report report))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((push-subscription push-subscription))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((poll poll))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((notification notification))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((mention mention))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((user-list user-list))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((attachment attachment))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((announcement-status announcement-status))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((announcement-account announcement-account))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Writer Method: (setf id) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

id.

Generic Function: identity-proof (client provider username)

Returns response from external identity provider.

See CLIENT

Package

tooter-objects.

Methods
Method: identity-proof ((client client) (provider string) (username string))
Source

queries.lisp.

Generic Reader: image (object)

Preview (URL)

See CARD

Package

tooter-objects.

Methods
Reader Method: image ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

image.

Generic Writer: (setf image) (object)
Package

tooter-objects.

Methods
Writer Method: (setf image) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

image.

Generic Reader: in-reply-to-account-id (object)

Returns the ID of the account this status is a reply to.

See STATUS

Package

tooter-objects.

Methods
Reader Method: in-reply-to-account-id ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

in-reply-to-account-id.

Generic Writer: (setf in-reply-to-account-id) (object)
Package

tooter-objects.

Methods
Writer Method: (setf in-reply-to-account-id) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

in-reply-to-account-id.

Generic Reader: in-reply-to-id (object)

Returns the ID of the status this status is a reply to.

See STATUS

Package

tooter-objects.

Methods
Reader Method: in-reply-to-id ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

in-reply-to-id.

Reader Method: in-reply-to-id ((status-params status-params))

automatically generated reader method

Source

objects.lisp.

Target Slot

in-reply-to-id.

Generic Writer: (setf in-reply-to-id) (object)
Package

tooter-objects.

Methods
Writer Method: (setf in-reply-to-id) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

in-reply-to-id.

Writer Method: (setf in-reply-to-id) ((status-params status-params))

automatically generated writer method

Source

objects.lisp.

Target Slot

in-reply-to-id.

Generic Function: instance (client)

Retrieve the instance information that the client is connected to.

See INSTANCE
See CLIENT

Package

tooter-objects.

Methods
Method: instance ((client client))
Source

queries.lisp.

Generic Reader: irreversible (object)

Returns if the server should drop the matching entities

See FILTER

Package

tooter-objects.

Methods
Reader Method: irreversible ((filter filter))

automatically generated reader method

Source

objects.lisp.

Target Slot

irreversible.

Generic Writer: (setf irreversible) (object)
Package

tooter-objects.

Methods
Writer Method: (setf irreversible) ((filter filter))

automatically generated writer method

Source

objects.lisp.

Target Slot

irreversible.

Generic Reader: key (object)

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

Package

tooter-client.

Methods
Reader Method: key ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

key.

Generic Writer: (setf key) (object)
Package

tooter-client.

Methods
Writer Method: (setf key) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

key.

Generic Reader: kind (object)

Returns the type/kind of object this instance is representing.

See ATTACHMENT
See CARD
See NOTIFICATION

Package

tooter-objects.

Methods
Reader Method: kind ((notification notification))

automatically generated reader method

Source

objects.lisp.

Target Slot

kind.

Reader Method: kind ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

kind.

Reader Method: kind ((attachment attachment))

automatically generated reader method

Source

objects.lisp.

Target Slot

kind.

Generic Writer: (setf kind) (object)
Package

tooter-objects.

Methods
Writer Method: (setf kind) ((notification notification))

automatically generated writer method

Source

objects.lisp.

Target Slot

kind.

Writer Method: (setf kind) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

kind.

Writer Method: (setf kind) ((attachment attachment))

automatically generated writer method

Source

objects.lisp.

Target Slot

kind.

Generic Reader: language (object)

Returns the ISO-6391 code for the language this status is in.

See STATUS

Package

tooter-objects.

Methods
Reader Method: language ((source source))

automatically generated reader method

Source

objects.lisp.

Target Slot

language.

Reader Method: language ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

language.

Generic Writer: (setf language) (object)
Package

tooter-objects.

Methods
Writer Method: (setf language) ((source source))

automatically generated writer method

Source

objects.lisp.

Target Slot

language.

Writer Method: (setf language) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

language.

Generic Reader: languages (object)

A list of ISO-6391 language codes that the instance advertises.

See INSTANCE

Package

tooter-objects.

Methods
Reader Method: languages ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

languages.

Generic Writer: (setf languages) (object)
Package

tooter-objects.

Methods
Writer Method: (setf languages) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

languages.

Generic Reader: last-status (object)

Returns the last STATUS of the conversation

Package

tooter-objects.

Methods
Reader Method: last-status ((conversation conversation))

automatically generated reader method

Source

objects.lisp.

Target Slot

last-status.

Generic Writer: (setf last-status) (object)
Package

tooter-objects.

Methods
Writer Method: (setf last-status) ((conversation conversation))

automatically generated writer method

Source

objects.lisp.

Target Slot

last-status.

Generic Reader: last-status-at (object)

Timestamp of the last status mentioning the tag

Package

tooter-objects.

Methods
Reader Method: last-status-at ((featured-tag featured-tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

last-status-at.

Generic Writer: (setf last-status-at) (object)
Package

tooter-objects.

Methods
Writer Method: (setf last-status-at) ((featured-tag featured-tag))

automatically generated writer method

Source

objects.lisp.

Target Slot

last-status-at.

Generic Reader: locked (object)

Returns whether the account is locked and requires confirming follow requests.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: locked ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

locked.

Generic Writer: (setf locked) (object)
Package

tooter-objects.

Methods
Writer Method: (setf locked) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

locked.

Generic Function: make-media (client file &key description focus)

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

Package

tooter-queries.

Methods
Method: make-media ((client client) file &key description focus)
Source

queries.lisp.

Generic Function: make-report (client id &key statuses comment forward)

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

Package

tooter-queries.

Methods
Method: make-report ((client client) (account account) &rest args)
Source

queries.lisp.

Method: make-report ((client client) (id string) &key statuses comment forward)
Source

queries.lisp.

Generic Function: make-status (client status &key in-reply-to media sensitive spoiler-text visibility language scheduled-at poll-options poll-expire-seconds poll-multiple poll-hide-totals idempotency-key)

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

Package

tooter-queries.

Methods
Method: make-status ((client client) status &key in-reply-to media sensitive spoiler-text visibility language scheduled-at poll-options poll-expire-seconds poll-multiple poll-hide-totals idempotency-key)
Source

queries.lisp.

Generic Function: make-subscription (client endpoint public-key secret &key alerts)

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

Package

tooter-queries.

Methods
Method: make-subscription ((client client) endpoint public-key secret &key alerts)
Source

queries.lisp.

Generic Function: make-user-list (client title)

Create a new user list with the given title.

See USER-LIST
See CLIENT

Package

tooter-queries.

Methods
Method: make-user-list ((client client) title)
Source

queries.lisp.

Generic Function: mark-read-conversation (client id)

Marks a conversation ad already read.

See CONVERSATION
See CLIENT

Package

tooter-queries.

Methods
Method: mark-read-conversation ((client client) (id string))
Source

queries.lisp.

Generic Reader: marked-home (object)

Returns information about last position in home timeline

See MARKER

Package

tooter-objects.

Methods
Reader Method: marked-home ((marker marker))

automatically generated reader method

Source

objects.lisp.

Target Slot

marked-home.

Generic Writer: (setf marked-home) (object)
Package

tooter-objects.

Methods
Writer Method: (setf marked-home) ((marker marker))

automatically generated writer method

Source

objects.lisp.

Target Slot

marked-home.

Generic Reader: marked-notifications (object)
Package

tooter-objects.

Methods
Reader Method: marked-notifications ((marker marker))

automatically generated reader method

Source

objects.lisp.

Target Slot

marked-notifications.

Generic Writer: (setf marked-notifications) (object)
Package

tooter-objects.

Methods
Writer Method: (setf marked-notifications) ((marker marker))

automatically generated writer method

Source

objects.lisp.

Target Slot

marked-notifications.

Generic Function: markers (client timeline)
Package

tooter-queries.

Methods
Method: markers ((client client) (timeline list))
Source

queries.lisp.

Generic Reader: me (object)

Returns if the user reacted to this announcement.

Package

tooter-objects.

Methods
Reader Method: me ((reaction reaction))

automatically generated reader method

Source

objects.lisp.

Target Slot

me.

Generic Writer: (setf me) (object)
Package

tooter-objects.

Methods
Writer Method: (setf me) ((reaction reaction))

automatically generated writer method

Source

objects.lisp.

Target Slot

me.

Generic Reader: media-attachments (object)

Returns a list of up to four media attachments.

See ATTACHMENT
See STATUS

Package

tooter-objects.

Methods
Reader Method: media-attachments ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

media-attachments.

Generic Writer: (setf media-attachments) (object)
Package

tooter-objects.

Methods
Writer Method: (setf media-attachments) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

media-attachments.

Generic Reader: media-ids (object)

WIP

See status-params

Package

tooter-objects.

Methods
Reader Method: media-ids ((status-params status-params))

automatically generated reader method

Source

objects.lisp.

Target Slot

media-ids.

Generic Writer: (setf media-ids) (object)
Package

tooter-objects.

Methods
Writer Method: (setf media-ids) ((status-params status-params))

automatically generated writer method

Source

objects.lisp.

Target Slot

media-ids.

Generic Reader: mentions (object)

Returns an array of mentions used in the status.

See STATUS
See MENTION

Package

tooter-objects.

Methods
Reader Method: mentions ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

mentions.

Reader Method: mentions ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

mentions.

Generic Writer: (setf mentions) (object)
Package

tooter-objects.

Methods
Writer Method: (setf mentions) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

mentions.

Writer Method: (setf mentions) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

mentions.

Generic Reader: message (condition)

Returns the error message string for the failed request.

See REQUEST-FAILED

Package

tooter-client.

Methods
Reader Method: message ((condition request-failed))
Source

client.lisp.

Target Slot

message.

Generic Reader: metadata (object)

Returns a metadata instance for additional information about the attachment’s media.

See ATTACHMENT

Package

tooter-objects.

Methods
Reader Method: metadata ((attachment attachment))

automatically generated reader method

Source

objects.lisp.

Target Slot

metadata.

Generic Writer: (setf metadata) (object)
Package

tooter-objects.

Methods
Writer Method: (setf metadata) ((attachment attachment))

automatically generated writer method

Source

objects.lisp.

Target Slot

metadata.

Generic Reader: moved (object)

If not NIL, returns the name of the account to which this account has moved.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: moved ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

moved.

Generic Writer: (setf moved) (object)
Package

tooter-objects.

Methods
Writer Method: (setf moved) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

moved.

Generic Reader: multiple (object)

Returns if the poll admits multiple choices

See POLL

Package

tooter-objects.

Methods
Reader Method: multiple ((poll poll))

automatically generated reader method

Source

objects.lisp.

Target Slot

multiple.

Generic Writer: (setf multiple) (object)
Package

tooter-objects.

Methods
Writer Method: (setf multiple) ((poll poll))

automatically generated writer method

Source

objects.lisp.

Target Slot

multiple.

Generic Function: mute (client id &key notifications)

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

Package

tooter-queries.

Methods
Method: mute ((client client) (status status) &key)
Source

queries.lisp.

Method: mute ((client client) (account account) &rest args)
Source

queries.lisp.

Method: mute ((client client) (id string) &key notifications)
Source

queries.lisp.

Generic Function: mute-conversation (client id)

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

Package

tooter-queries.

Methods
Method: mute-conversation ((client client) (status status))
Source

queries.lisp.

Method: mute-conversation ((client client) (id string))
Source

queries.lisp.

Generic Reader: muted (object)

Returns whether this status should be muted.

See STATUS

Package

tooter-objects.

Methods
Reader Method: muted ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

muted.

Generic Writer: (setf muted) (object)
Package

tooter-objects.

Methods
Writer Method: (setf muted) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

muted.

Generic Function: mutes (client &key max-id since-id limit)

Returns a list of accounts that you have muted.

See ACCOUNT
See CLIENT

Package

tooter-queries.

Methods
Method: mutes ((client client) &key max-id since-id limit)
Source

queries.lisp.

Generic Reader: muting (object)

Returns whether the account is muted by you.

See RELATIONSHIP

Package

tooter-objects.

Methods
Reader Method: muting ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

muting.

Generic Writer: (setf muting) (object)
Package

tooter-objects.

Methods
Writer Method: (setf muting) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

muting.

Generic Reader: muting-notifications (object)

Returns whether notifications from the account are muted by you.

See RELATIONSHIP

Package

tooter-objects.

Methods
Reader Method: muting-notifications ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

muting-notifications.

Generic Writer: (setf muting-notifications) (object)
Package

tooter-objects.

Methods
Writer Method: (setf muting-notifications) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

muting-notifications.

Generic Reader: name (object)

Returns the emoji specification: unicode value or string representation (i.e. ":name:").

Package

tooter-objects.

Methods
Reader Method: name ((featured-tag featured-tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((tag tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((reaction reaction))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((application application))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((field field))

automatically generated reader method

Source

objects.lisp.

Target Slot

name.

Reader Method: name ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

name.

Generic Writer: (setf name) (object)
Package

tooter-objects.

Methods
Writer Method: (setf name) ((featured-tag featured-tag))

automatically generated writer method

Source

objects.lisp.

Target Slot

name.

Writer Method: (setf name) ((tag tag))

automatically generated writer method

Source

objects.lisp.

Target Slot

name.

Writer Method: (setf name) ((reaction reaction))

automatically generated writer method

Source

objects.lisp.

Target Slot

name.

Writer Method: (setf name) ((application application))

automatically generated writer method

Source

objects.lisp.

Target Slot

name.

Writer Method: (setf name) ((field field))

automatically generated writer method

Source

objects.lisp.

Target Slot

name.

Writer Method: (setf name) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

name.

Generic Reader: note (object)

Returns the user biography.

See SOURCE

Package

tooter-objects.

Methods
Reader Method: note ((source source))

automatically generated reader method

Source

objects.lisp.

Target Slot

note.

Reader Method: note ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

note.

Generic Writer: (setf note) (object)
Package

tooter-objects.

Methods
Writer Method: (setf note) ((source source))

automatically generated writer method

Source

objects.lisp.

Target Slot

note.

Writer Method: (setf note) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

note.

Generic Function: notifications (client &key max-id min-id since-id limit exclude-types account-id)

Returns a list of notifications about status updates.

See MARKER
See NOTIFICATION
See CLIENT

Package

tooter-queries.

Methods
Method: notifications ((client client) &key max-id min-id since-id limit exclude-types account-id)
Source

queries.lisp.

Generic Reader: options (object)

Returns the possible choices for this poll.

See POLL

Package

tooter-objects.

Methods
Reader Method: options ((poll poll))

automatically generated reader method

Source

objects.lisp.

Target Slot

options.

Generic Writer: (setf options) (object)
Package

tooter-objects.

Methods
Writer Method: (setf options) ((poll poll))

automatically generated writer method

Source

objects.lisp.

Target Slot

options.

Generic Reader: original (object)

Returns metadata information for the original version of the attachment media, if available.

See METADATA
See IMAGE-METADATA
See VIDEO-METADATA

Package

tooter-objects.

Methods
Reader Method: original ((metadata metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

original.

Generic Writer: (setf original) (object)
Package

tooter-objects.

Methods
Writer Method: (setf original) ((metadata metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

original.

Generic Reader: own-votes (object)

Returns the choice of an user (requires to be called with a valid user token.

See POLL

Package

tooter-objects.

Methods
Reader Method: own-votes ((poll poll))

automatically generated reader method

Source

objects.lisp.

Target Slot

own-votes.

Generic Writer: (setf own-votes) (object)
Package

tooter-objects.

Methods
Writer Method: (setf own-votes) ((poll poll))

automatically generated writer method

Source

objects.lisp.

Target Slot

own-votes.

Generic Reader: params (object)

Returns ...

See SCHEDULED-STATUS

Package

tooter-objects.

Methods
Reader Method: params ((scheduled-status scheduled-status))

automatically generated reader method

Source

objects.lisp.

Target Slot

params.

Generic Writer: (setf params) (object)
Package

tooter-objects.

Methods
Writer Method: (setf params) ((scheduled-status scheduled-status))

automatically generated writer method

Source

objects.lisp.

Target Slot

params.

Generic Reader: parent (object)

Returns the original status this status is a reblog of.

See STATUS

Package

tooter-objects.

Methods
Reader Method: parent ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

parent.

Generic Writer: (setf parent) (object)
Package

tooter-objects.

Methods
Writer Method: (setf parent) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

parent.

Generic Function: peers (client)

Retrieve the instances that the server knows.

See CLIENT

Package

tooter-queries.

Methods
Method: peers ((client client))
Source

queries.lisp.

Generic Reader: phrase (object)

Returns the filter’s text

Package

tooter-objects.

Methods
Reader Method: phrase ((filter filter))

automatically generated reader method

Source

objects.lisp.

Target Slot

phrase.

Generic Writer: (setf phrase) (object)
Package

tooter-objects.

Methods
Writer Method: (setf phrase) ((filter filter))

automatically generated writer method

Source

objects.lisp.

Target Slot

phrase.

Generic Function: pin (client id)

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

Package

tooter-queries.

Methods
Method: pin ((client client) (status status))
Source

queries.lisp.

Method: pin ((client client) (id string))
Source

queries.lisp.

Generic Reader: pinned (object)

Returns whether this status is pinned on the user’s profile.

See STATUS

Package

tooter-objects.

Methods
Reader Method: pinned ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

pinned.

Generic Writer: (setf pinned) (object)
Package

tooter-objects.

Methods
Writer Method: (setf pinned) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

pinned.

Generic Reader: poll (object)

Returns a poll attached to this status, nil if no poll is attached.

See STATUS

Package

tooter-objects.

Methods
Reader Method: poll ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

poll.

Generic Writer: (setf poll) (object)
Package

tooter-objects.

Methods
Writer Method: (setf poll) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

poll.

Generic Function: poll-vote (client id choices)

Votes for choices in a poll.

See CLIENT
See POLL
See POLL-OPTION

Package

tooter-queries.

Methods
Method: poll-vote ((client client) (poll poll) choices)
Source

queries.lisp.

Method: poll-vote ((client client) (id string) (choices list))
Source

queries.lisp.

Generic Function: polls (client id)

Returns a poll

See CLIENT See POLL See POLL-OPTION

Package

tooter-queries.

Methods
Method: polls ((client client) (poll poll))
Source

queries.lisp.

Method: polls ((client client) (id string))
Source

queries.lisp.

Generic Reader: posting-default-language (object)

Return the default language for post.

See PREFERENCES

Package

tooter-objects.

Methods
Reader Method: posting-default-language ((preferences preferences))

automatically generated reader method

Source

objects.lisp.

Target Slot

posting-default-language.

Generic Writer: (setf posting-default-language) (object)
Package

tooter-objects.

Methods
Writer Method: (setf posting-default-language) ((preferences preferences))

automatically generated writer method

Source

objects.lisp.

Target Slot

posting-default-language.

Generic Reader: posting-default-sensitive (object)

Returns if flag post as "sensible" by default.

See PREFERENCES

Package

tooter-objects.

Methods
Reader Method: posting-default-sensitive ((preferences preferences))

automatically generated reader method

Source

objects.lisp.

Target Slot

posting-default-sensitive.

Generic Writer: (setf posting-default-sensitive) (object)
Package

tooter-objects.

Methods
Writer Method: (setf posting-default-sensitive) ((preferences preferences))

automatically generated writer method

Source

objects.lisp.

Target Slot

posting-default-sensitive.

Generic Reader: posting-default-visibility (object)

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

Package

tooter-objects.

Methods
Reader Method: posting-default-visibility ((preferences preferences))

automatically generated reader method

Source

objects.lisp.

Target Slot

posting-default-visibility.

Generic Writer: (setf posting-default-visibility) (object)
Package

tooter-objects.

Methods
Writer Method: (setf posting-default-visibility) ((preferences preferences))

automatically generated writer method

Source

objects.lisp.

Target Slot

posting-default-visibility.

Generic Function: preferences (client)

Returns the user preferences

See PREFERENCES

Package

tooter-objects.

Methods
Method: preferences ((client client))
Source

queries.lisp.

Generic Reader: preview-card (object)

Returns a convenient JSON preview for links contained in a status.

See STATUS

Package

tooter-objects.

Methods
Reader Method: preview-card ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

preview-card.

Generic Writer: (setf preview-card) (object)
Package

tooter-objects.

Methods
Writer Method: (setf preview-card) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

preview-card.

Generic Reader: preview-url (object)

Returns the URL for the media’s preview, which may be resized and cropped.

See ATTACHMENT

Package

tooter-objects.

Methods
Reader Method: preview-url ((attachment attachment))

automatically generated reader method

Source

objects.lisp.

Target Slot

preview-url.

Generic Writer: (setf preview-url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf preview-url) ((attachment attachment))

automatically generated writer method

Source

objects.lisp.

Target Slot

preview-url.

Generic Reader: privacy (object)

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

Package

tooter-objects.

Methods
Reader Method: privacy ((source source))

automatically generated reader method

Source

objects.lisp.

Target Slot

privacy.

Generic Writer: (setf privacy) (object)
Package

tooter-objects.

Methods
Writer Method: (setf privacy) ((source source))

automatically generated writer method

Source

objects.lisp.

Target Slot

privacy.

Generic Reader: profile-url (object)

Returns the URL of the profile on the identity provider

See IDENTITY-PROOF

Package

tooter-objects.

Methods
Reader Method: profile-url ((identity-proof identity-proof))

automatically generated reader method

Source

objects.lisp.

Target Slot

profile-url.

Generic Writer: (setf profile-url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf profile-url) ((identity-proof identity-proof))

automatically generated writer method

Source

objects.lisp.

Target Slot

profile-url.

Generic Reader: proof-url (object)

Returns the URL of the proof of identity on the identity provider

See IDENTITY-PROOF

Package

tooter-objects.

Methods
Reader Method: proof-url ((identity-proof identity-proof))

automatically generated reader method

Source

objects.lisp.

Target Slot

proof-url.

Generic Writer: (setf proof-url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf proof-url) ((identity-proof identity-proof))

automatically generated writer method

Source

objects.lisp.

Target Slot

proof-url.

Generic Reader: provider (object)

Returns the name of the identity provider

See IDENTITY-PROOF

Package

tooter-objects.

Methods
Reader Method: provider ((identity-proof identity-proof))

automatically generated reader method

Source

objects.lisp.

Target Slot

provider.

Generic Writer: (setf provider) (object)
Package

tooter-objects.

Methods
Writer Method: (setf provider) ((identity-proof identity-proof))

automatically generated writer method

Source

objects.lisp.

Target Slot

provider.

Generic Reader: provider-name (object)

Returns the name of the status’ instance.

See CARD

Package

tooter-objects.

Methods
Reader Method: provider-name ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

provider-name.

Generic Writer: (setf provider-name) (object)
Package

tooter-objects.

Methods
Writer Method: (setf provider-name) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

provider-name.

Generic Reader: provider-url (object)

Returns the URL to the status’ instance.

See CARD

Package

tooter-objects.

Methods
Reader Method: provider-url ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

provider-url.

Generic Writer: (setf provider-url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf provider-url) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

provider-url.

Generic Reader: provider-username (object)

Returns the username on the identity provider

See IDENTITY-PROOF

Package

tooter-objects.

Methods
Reader Method: provider-username ((identity-proof identity-proof))

automatically generated reader method

Source

objects.lisp.

Target Slot

provider-username.

Generic Writer: (setf provider-username) (object)
Package

tooter-objects.

Methods
Writer Method: (setf provider-username) ((identity-proof identity-proof))

automatically generated writer method

Source

objects.lisp.

Target Slot

provider-username.

Generic Reader: published (object)

Returns if this announcement is active or not.

See ANNOUNCEMENT

Package

tooter-objects.

Methods
Reader Method: published ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

published.

Generic Writer: (setf published) (object)
Package

tooter-objects.

Methods
Writer Method: (setf published) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

published.

Generic Reader: published-at (object)

Returns the date when this announcement was published.

See ANNOUNCEMENT

Package

tooter-objects.

Methods
Reader Method: published-at ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

published-at.

Generic Writer: (setf published-at) (object)
Package

tooter-objects.

Methods
Writer Method: (setf published-at) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

published-at.

Generic Function: query (client endpoint &rest parameters)

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

Package

tooter-client.

Methods
Method: query ((client client) endpoint &rest parameters)
Source

client.lisp.

Generic Reader: reaction-count (object)

Returns the number of users that reacted to an announcement.

Package

tooter-objects.

Methods
Reader Method: reaction-count ((reaction reaction))

automatically generated reader method

Source

objects.lisp.

Target Slot

reaction-count.

Generic Writer: (setf reaction-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf reaction-count) ((reaction reaction))

automatically generated writer method

Source

objects.lisp.

Target Slot

reaction-count.

Generic Reader: reactions (object)

Returns the reactions to this announcement

See ANNOUNCEMENT
See REACTION

Package

tooter-objects.

Methods
Reader Method: reactions ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

reactions.

Generic Writer: (setf reactions) (object)
Package

tooter-objects.

Methods
Writer Method: (setf reactions) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

reactions.

Generic Reader: reading-expand-media (object)

:SHOW-ALL – show all media :HIDE-ALL – hide all media

See PREFERENCES

Package

tooter-objects.

Methods
Reader Method: reading-expand-media ((preferences preferences))

automatically generated reader method

Source

objects.lisp.

Target Slot

reading-expand-media.

Generic Writer: (setf reading-expand-media) (object)
Package

tooter-objects.

Methods
Writer Method: (setf reading-expand-media) ((preferences preferences))

automatically generated writer method

Source

objects.lisp.

Target Slot

reading-expand-media.

Generic Reader: reading-expand-spoilers (object)

Returns if expands posts marked as ’sensible’.

See PREFERENCES

Package

tooter-objects.

Methods
Reader Method: reading-expand-spoilers ((preferences preferences))

automatically generated reader method

Source

objects.lisp.

Target Slot

reading-expand-spoilers.

Generic Writer: (setf reading-expand-spoilers) (object)
Package

tooter-objects.

Methods
Writer Method: (setf reading-expand-spoilers) ((preferences preferences))

automatically generated writer method

Source

objects.lisp.

Target Slot

reading-expand-spoilers.

Generic Reader: readp (object)

Returns if this announcement has been read by the user

See ANNOUNCEMENT

Package

tooter-objects.

Methods
Reader Method: readp ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

readp.

Generic Writer: (setf readp) (object)
Package

tooter-objects.

Methods
Writer Method: (setf readp) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

readp.

Generic Function: reblog (client id)

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

Package

tooter-queries.

Methods
Method: reblog ((client client) (status status))
Source

queries.lisp.

Method: reblog ((client client) (id string))
Source

queries.lisp.

Generic Reader: reblogged (object)

Returns whether you have reblogged this status.

See STATUS

Package

tooter-objects.

Methods
Reader Method: reblogged ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

reblogged.

Generic Writer: (setf reblogged) (object)
Package

tooter-objects.

Methods
Writer Method: (setf reblogged) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

reblogged.

Generic Function: rebloggers (client id &key max-id since-id limit)

Retrieve the list of accounts that reblogged the status.

The status can either be a STATUS instance, or an ID of one.

See STATUS
See CLIENT
See ACCOUNT

Package

tooter-queries.

Methods
Method: rebloggers ((client client) (status status) &rest args)
Source

queries.lisp.

Method: rebloggers ((client client) (id string) &key max-id since-id limit)
Source

queries.lisp.

Generic Reader: reblogs-count (object)

Returns the number of reblogs this status has received.

See STATUS

Package

tooter-objects.

Methods
Reader Method: reblogs-count ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

reblogs-count.

Generic Writer: (setf reblogs-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf reblogs-count) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

reblogs-count.

Generic Reader: redirect (object)

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

Package

tooter-client.

Methods
Reader Method: redirect ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

redirect.

Generic Writer: (setf redirect) (object)
Package

tooter-client.

Methods
Writer Method: (setf redirect) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

redirect.

Generic Function: register (client)

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

Package

tooter-client.

Methods
Method: register ((client client))
Source

client.lisp.

Generic Reader: registrations (object)

Returns if is possible to register an user with this instance.

See INSTANCE

Package

tooter-objects.

Methods
Reader Method: registrations ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

registrations.

Reader Method: registrations ((activity activity))

automatically generated reader method

Source

objects.lisp.

Target Slot

registrations.

Generic Writer: (setf registrations) (object)
Package

tooter-objects.

Methods
Writer Method: (setf registrations) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

registrations.

Writer Method: (setf registrations) ((activity activity))

automatically generated writer method

Source

objects.lisp.

Target Slot

registrations.

Generic Function: reject-request (client id)

Reject the follow request of the given account.

See CLIENT
See ACCOUNT

Package

tooter-queries.

Methods
Method: reject-request ((client client) (account account))
Source

queries.lisp.

Method: reject-request ((client client) (id string))
Source

queries.lisp.

Generic Function: relationships (client ids)

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

Package

tooter-queries.

Methods
Method: relationships ((client client) (account account))
Source

queries.lisp.

Method: relationships ((client client) (ids cons))
Source

queries.lisp.

Generic Reader: remote-url (object)

Returns the remote URL if the attachment resides on a remote instance.

See ATTACHMENT

Package

tooter-objects.

Methods
Reader Method: remote-url ((attachment attachment))

automatically generated reader method

Source

objects.lisp.

Target Slot

remote-url.

Generic Writer: (setf remote-url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf remote-url) ((attachment attachment))

automatically generated writer method

Source

objects.lisp.

Target Slot

remote-url.

Generic Function: remove-user-list-accounts (client id accounts)

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

Package

tooter-queries.

Methods
Method: remove-user-list-accounts ((client client) (user-list user-list) accounts)
Source

queries.lisp.

Method: remove-user-list-accounts ((client client) (id string) accounts)
Source

queries.lisp.

Generic Reader: replies-count (object)

Returns the number of replies this status has received.

See STATUS

Package

tooter-objects.

Methods
Reader Method: replies-count ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

replies-count.

Generic Writer: (setf replies-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf replies-count) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

replies-count.

Generic Function: reports (client)

Returns a list of submitted reports.

See REPORT
See CLIENT

Package

tooter-queries.

Methods
Method: reports ((client client))
Source

queries.lisp.

Generic Reader: requested (object)

Returns whether you have requested a follow to the account.

See RELATIONSHIP

Package

tooter-objects.

Methods
Reader Method: requested ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

requested.

Generic Writer: (setf requested) (object)
Package

tooter-objects.

Methods
Writer Method: (setf requested) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

requested.

Generic Reader: results-accounts (object)

Returns a list of matching accounts.

See RESULTS

Package

tooter-objects.

Methods
Reader Method: results-accounts ((results results))

automatically generated reader method

Source

objects.lisp.

Target Slot

results-accounts.

Generic Writer: (setf results-accounts) (object)
Package

tooter-objects.

Methods
Writer Method: (setf results-accounts) ((results results))

automatically generated writer method

Source

objects.lisp.

Target Slot

results-accounts.

Generic Reader: results-statuses (object)

Returns a list of matching status.

See RESULTS

Package

tooter-objects.

Methods
Reader Method: results-statuses ((results results))

automatically generated reader method

Source

objects.lisp.

Target Slot

results-statuses.

Generic Writer: (setf results-statuses) (object)
Package

tooter-objects.

Methods
Writer Method: (setf results-statuses) ((results results))

automatically generated writer method

Source

objects.lisp.

Target Slot

results-statuses.

Generic Function: save-markers (client &key last-status-read last-notification-read)
Package

tooter-queries.

Methods
Method: save-markers ((client client) &key last-status-read last-notification-read)
Source

queries.lisp.

Generic Reader: scheduled-at (object)

Returns ...

See SCHEDULED-STATUS

Package

tooter-objects.

Methods
Reader Method: scheduled-at ((scheduled-status scheduled-status))

automatically generated reader method

Source

objects.lisp.

Target Slot

scheduled-at.

Reader Method: scheduled-at ((status-params status-params))

automatically generated reader method

Source

objects.lisp.

Target Slot

scheduled-at.

Generic Writer: (setf scheduled-at) (object)
Package

tooter-objects.

Methods
Writer Method: (setf scheduled-at) ((scheduled-status scheduled-status))

automatically generated writer method

Source

objects.lisp.

Target Slot

scheduled-at.

Writer Method: (setf scheduled-at) ((status-params status-params))

automatically generated writer method

Source

objects.lisp.

Target Slot

scheduled-at.

Generic Reader: scope (object)

Returns the oauth access token scope (space separated fields).

See TOKEN

Package

tooter-objects.

Methods
Reader Method: scope ((token token))

automatically generated reader method

Source

objects.lisp.

Target Slot

scope.

Generic Writer: (setf scope) (object)
Package

tooter-objects.

Methods
Writer Method: (setf scope) ((token token))

automatically generated writer method

Source

objects.lisp.

Target Slot

scope.

Generic Reader: scopes (object)

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

Package

tooter-client.

Methods
Reader Method: scopes ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

scopes.

Generic Writer: (setf scopes) (object)
Package

tooter-client.

Methods
Writer Method: (setf scopes) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

scopes.

Generic Function: search-accounts (client query &key limit following resolve)

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

Package

tooter-queries.

Methods
Method: search-accounts ((client client) query &key limit following resolve)
Source

queries.lisp.

Generic Reader: secret (object)

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

Package

tooter-client.

Methods
Reader Method: secret ((client client))

automatically generated reader method

Source

client.lisp.

Target Slot

secret.

Generic Writer: (setf secret) (object)
Package

tooter-client.

Methods
Writer Method: (setf secret) ((client client))

automatically generated writer method

Source

client.lisp.

Target Slot

secret.

Generic Reader: sensitive (object)

Returns if the the user biography.

See SOURCE

Package

tooter-objects.

Methods
Reader Method: sensitive ((source source))

automatically generated reader method

Source

objects.lisp.

Target Slot

sensitive.

Reader Method: sensitive ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

sensitive.

Reader Method: sensitive ((status-params status-params))

automatically generated reader method

Source

objects.lisp.

Target Slot

sensitive.

Generic Writer: (setf sensitive) (object)
Package

tooter-objects.

Methods
Writer Method: (setf sensitive) ((source source))

automatically generated writer method

Source

objects.lisp.

Target Slot

sensitive.

Writer Method: (setf sensitive) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

sensitive.

Writer Method: (setf sensitive) ((status-params status-params))

automatically generated writer method

Source

objects.lisp.

Target Slot

sensitive.

Generic Reader: server-key (object)

The public key signature for verification of deliveries.

See PUSH-SUBSCRIPTION

Package

tooter-objects.

Methods
Reader Method: server-key ((push-subscription push-subscription))

automatically generated reader method

Source

objects.lisp.

Target Slot

server-key.

Generic Writer: (setf server-key) (object)
Package

tooter-objects.

Methods
Writer Method: (setf server-key) ((push-subscription push-subscription))

automatically generated writer method

Source

objects.lisp.

Target Slot

server-key.

Generic Reader: short-description (object)

Returns a short description of the object.

See INSTANCE

Package

tooter-objects.

Methods
Reader Method: short-description ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

short-description.

Generic Writer: (setf short-description) (object)
Package

tooter-objects.

Methods
Writer Method: (setf short-description) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

short-description.

Generic Reader: shortcode (object)

Returns the short code to display the emoji.

See EMOJI

Package

tooter-objects.

Methods
Reader Method: shortcode ((emoji emoji))

automatically generated reader method

Source

objects.lisp.

Target Slot

shortcode.

Generic Writer: (setf shortcode) (object)
Package

tooter-objects.

Methods
Writer Method: (setf shortcode) ((emoji emoji))

automatically generated writer method

Source

objects.lisp.

Target Slot

shortcode.

Generic Reader: showing-reblogs (object)

Returns if this user has boosted your toots.

See RELATIONSHIP

Package

tooter-objects.

Methods
Reader Method: showing-reblogs ((relationship relationship))

automatically generated reader method

Source

objects.lisp.

Target Slot

showing-reblogs.

Generic Writer: (setf showing-reblogs) (object)
Package

tooter-objects.

Methods
Writer Method: (setf showing-reblogs) ((relationship relationship))

automatically generated writer method

Source

objects.lisp.

Target Slot

showing-reblogs.

Generic Reader: size (object)

Returns the size of the image.

See IMAGE-METADATA

Package

tooter-objects.

Methods
Reader Method: size ((image-metadata image-metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

size.

Generic Writer: (setf size) (object)
Package

tooter-objects.

Methods
Writer Method: (setf size) ((image-metadata image-metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

size.

Generic Reader: small (object)

Returns metadata information for the small version of the attachment media, if available.

See METADATA
See IMAGE-METADATA
See VIDEO-METADATA

Package

tooter-objects.

Methods
Reader Method: small ((metadata metadata))

automatically generated reader method

Source

objects.lisp.

Target Slot

small.

Generic Writer: (setf small) (object)
Package

tooter-objects.

Methods
Writer Method: (setf small) ((metadata metadata))

automatically generated writer method

Source

objects.lisp.

Target Slot

small.

Generic Reader: source (object)

Returns a hash table of extra information about the account.

This is only set for accounts retrieved through verify-credentials.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: source ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

source.

Generic Writer: (setf source) (object)
Package

tooter-objects.

Methods
Writer Method: (setf source) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

source.

Generic Reader: spoiler-text (object)

Returns the spoiler text for the status.

See STATUS

Package

tooter-objects.

Methods
Reader Method: spoiler-text ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

spoiler-text.

Reader Method: spoiler-text ((status-params status-params))

automatically generated reader method

Source

objects.lisp.

Target Slot

spoiler-text.

Generic Writer: (setf spoiler-text) (object)
Package

tooter-objects.

Methods
Writer Method: (setf spoiler-text) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

spoiler-text.

Writer Method: (setf spoiler-text) ((status-params status-params))

automatically generated writer method

Source

objects.lisp.

Target Slot

spoiler-text.

Generic Reader: starts-at (object)

Returns a date when announcement will start.

See ANNOUNCEMENT

Package

tooter-objects.

Methods
Reader Method: starts-at ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

starts-at.

Generic Writer: (setf starts-at) (object)
Package

tooter-objects.

Methods
Writer Method: (setf starts-at) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

starts-at.

Generic Reader: static-url (object)

Returns the static image of the emoji.

See EMOJI

Package

tooter-objects.

Methods
Reader Method: static-url ((reaction reaction))

automatically generated reader method

Source

objects.lisp.

Target Slot

static-url.

Reader Method: static-url ((emoji emoji))

automatically generated reader method

Source

objects.lisp.

Target Slot

static-url.

Generic Writer: (setf static-url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf static-url) ((reaction reaction))

automatically generated writer method

Source

objects.lisp.

Target Slot

static-url.

Writer Method: (setf static-url) ((emoji emoji))

automatically generated writer method

Source

objects.lisp.

Target Slot

static-url.

Generic Reader: stats (object)

Statistics about this instance.

See INSTANCE-STATS
See INSTANCE

Package

tooter-objects.

Methods
Reader Method: stats ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

stats.

Generic Writer: (setf stats) (object)
Package

tooter-objects.

Methods
Writer Method: (setf stats) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

stats.

Generic Reader: status (object)

Returns the status the notification is about.

See NOTIFICATION

Package

tooter-objects.

Methods
Reader Method: status ((notification notification))

automatically generated reader method

Source

objects.lisp.

Target Slot

status.

Generic Writer: (setf status) (object)
Package

tooter-objects.

Methods
Writer Method: (setf status) ((notification notification))

automatically generated writer method

Source

objects.lisp.

Target Slot

status.

Generic Reader: status-count (object)

Returns the status counts for this instance.

See INSTANCE-STATS

Package

tooter-objects.

Methods
Reader Method: status-count ((instance-stats instance-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

status-count.

Generic Writer: (setf status-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf status-count) ((instance-stats instance-stats))

automatically generated writer method

Source

objects.lisp.

Target Slot

status-count.

Generic Reader: statuses (object)

Number of statuses

See ACTIVITY See RESULTS

Package

tooter-objects.

Methods
Reader Method: statuses ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

statuses.

Reader Method: statuses ((activity activity))

automatically generated reader method

Source

objects.lisp.

Target Slot

statuses.

Generic Writer: (setf statuses) (object)
Package

tooter-objects.

Methods
Writer Method: (setf statuses) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

statuses.

Writer Method: (setf statuses) ((activity activity))

automatically generated writer method

Source

objects.lisp.

Target Slot

statuses.

Generic Reader: statuses-count (object)

Returns the number of statuses the account has made.

See ACCOUNT

Package

tooter-objects.

Methods
Reader Method: statuses-count ((featured-tag featured-tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

statuses-count.

Reader Method: statuses-count ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

statuses-count.

Generic Writer: (setf statuses-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf statuses-count) ((featured-tag featured-tag))

automatically generated writer method

Source

objects.lisp.

Target Slot

statuses-count.

Writer Method: (setf statuses-count) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

statuses-count.

Generic Function: submit (client endpoint &rest parameters)

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

Package

tooter-client.

Methods
Method: submit ((client client) endpoint &rest parameters)
Source

client.lisp.

Generic Function: subscription (client)

Retrieve the current push subscription settings.

See CLIENT
See PUSH-SUBSCRIPTION

Package

tooter-queries.

Methods
Method: subscription ((client client))
Source

queries.lisp.

Generic Reader: tags (object)

Returns an array of tags used in the status.

See STATUS
See TAG

Package

tooter-objects.

Methods
Reader Method: tags ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

tags.

Reader Method: tags ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

tags.

Generic Writer: (setf tags) (object)
Package

tooter-objects.

Methods
Writer Method: (setf tags) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

tags.

Writer Method: (setf tags) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

tags.

Generic Reader: text (object)

WIP

See status-params

Package

tooter-objects.

Methods
Reader Method: text ((status-params status-params))

automatically generated reader method

Source

objects.lisp.

Target Slot

text.

Generic Writer: (setf text) (object)
Package

tooter-objects.

Methods
Writer Method: (setf text) ((status-params status-params))

automatically generated writer method

Source

objects.lisp.

Target Slot

text.

Generic Reader: text-url (object)

Returns a shorter URL for usage in text snippets if the attachment is on the local instance.

See ATTACHMENT

Package

tooter-objects.

Methods
Reader Method: text-url ((attachment attachment))

automatically generated reader method

Source

objects.lisp.

Target Slot

text-url.

Generic Writer: (setf text-url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf text-url) ((attachment attachment))

automatically generated writer method

Source

objects.lisp.

Target Slot

text-url.

Generic Reader: thumbnail (object)

banner of this instance.

See INSTANCE

Package

tooter-objects.

Methods
Reader Method: thumbnail ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

thumbnail.

Generic Writer: (setf thumbnail) (object)
Package

tooter-objects.

Methods
Writer Method: (setf thumbnail) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

thumbnail.

Generic Function: timeline (client kind &key local only-media max-id since-id limit min-id)

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

Package

tooter-queries.

Source

queries.lisp.

Methods
Method: timeline ((client client) (user-list user-list) &rest args)
Method: timeline ((client client) (tag tag) &rest args)
Method: timeline ((client client) (id string) &rest args)
Method: timeline ((client client) (kind (eql :public)) &rest args)
Method: timeline ((client client) (kind (eql :home)) &rest args)
Generic Function: timeline-tag (client tag &rest args)

Returns statuses for the given hashtag.

See CLIENT
See TAG
See STATUS

Package

tooter-queries.

Source

queries.lisp.

Methods
Method: timeline-tag ((client client) (tag string) &rest args)
Generic Reader: title (object)

Returns the title of the object.

See CARD
See INSTANCE
See USER-LIST

Package

tooter-objects.

Methods
Reader Method: title ((poll-option poll-option))

automatically generated reader method

Source

objects.lisp.

Target Slot

title.

Reader Method: title ((user-list user-list))

automatically generated reader method

Source

objects.lisp.

Target Slot

title.

Reader Method: title ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

title.

Reader Method: title ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

title.

Generic Writer: (setf title) (object)
Package

tooter-objects.

Methods
Writer Method: (setf title) ((poll-option poll-option))

automatically generated writer method

Source

objects.lisp.

Target Slot

title.

Writer Method: (setf title) ((user-list user-list))

automatically generated writer method

Source

objects.lisp.

Target Slot

title.

Writer Method: (setf title) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

title.

Writer Method: (setf title) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

title.

Generic Reader: token-type (object)

Returns the oauth access token type ("Bearer" for mastodon).

See TOKEN

Package

tooter-objects.

Methods
Reader Method: token-type ((token token))

automatically generated reader method

Source

objects.lisp.

Target Slot

token-type.

Generic Writer: (setf token-type) (object)
Package

tooter-objects.

Methods
Writer Method: (setf token-type) ((token token))

automatically generated writer method

Source

objects.lisp.

Target Slot

token-type.

Returns a list of trending hashtags.

See CLIENT

Package

tooter-queries.

Methods
Source

queries.lisp.

Generic Function: unblock (client id)

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

Package

tooter-queries.

Methods
Method: unblock ((client client) (domain string))
Source

queries.lisp.

Method: unblock ((client client) (account account))
Source

queries.lisp.

Generic Function: unbookmark (client id)

Remove a STATUS to user’s bookmark.

See CLIENT
See STATUS

Package

tooter-queries.

Methods
Method: unbookmark ((client client) (status status))
Source

queries.lisp.

Method: unbookmark ((client client) (id string))
Source

queries.lisp.

Generic Function: unfavourite (client id)

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

Package

tooter-queries.

Methods
Method: unfavourite ((client client) (status status))
Source

queries.lisp.

Method: unfavourite ((client client) (id string))
Source

queries.lisp.

Generic Function: unfollow (client id)

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

Package

tooter-queries.

Methods
Method: unfollow ((client client) (account account))
Source

queries.lisp.

Method: unfollow ((client client) (id string))
Source

queries.lisp.

Generic Function: unfollow-tag (client tag)

Follow a tag.

See CLIENT See TAG

Package

tooter-queries.

Source

queries.lisp.

Methods
Method: unfollow-tag ((client client) (tag tag))
Method: unfollow-tag ((client client) (tag string))
Generic Function: unmute (client id)

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

Package

tooter-queries.

Methods
Method: unmute ((client client) (status status))
Source

queries.lisp.

Method: unmute ((client client) (account account))
Source

queries.lisp.

Method: unmute ((client client) (id string))
Source

queries.lisp.

Generic Function: unmute-conversation (client id)

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

Package

tooter-queries.

Methods
Method: unmute-conversation ((client client) (status status))
Source

queries.lisp.

Method: unmute-conversation ((client client) (id string))
Source

queries.lisp.

Generic Function: unpin (client id)

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

Package

tooter-queries.

Methods
Method: unpin ((client client) (status status))
Source

queries.lisp.

Method: unpin ((client client) (id string))
Source

queries.lisp.

Generic Reader: unread (object)

Returns non nil if this conversation has been marked not red

Package

tooter-objects.

Methods
Reader Method: unread ((conversation conversation))

automatically generated reader method

Source

objects.lisp.

Target Slot

unread.

Generic Writer: (setf unread) (object)
Package

tooter-objects.

Methods
Writer Method: (setf unread) ((conversation conversation))

automatically generated writer method

Source

objects.lisp.

Target Slot

unread.

Generic Function: unreblog (client id)

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

Package

tooter-queries.

Methods
Method: unreblog ((client client) (status status))
Source

queries.lisp.

Method: unreblog ((client client) (id string))
Source

queries.lisp.

Generic Function: update-credentials (client &key display-name note avatar header locked fields)

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

Package

tooter-queries.

Methods
Method: update-credentials ((client client) &key display-name note avatar header locked fields)
Source

queries.lisp.

Generic Function: update-filter (client id phrase context &key irreversible whole-word expires-in)

Update an existing filter.

See CLIENT
See FILTER

Package

tooter-queries.

Methods
Method: update-filter ((client client) id phrase context &key irreversible whole-word expires-in)
Source

queries.lisp.

Generic Function: update-media (client id &key description focus)

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

Package

tooter-queries.

Methods
Method: update-media ((client client) (attachment attachment) &rest args)
Source

queries.lisp.

Method: update-media ((client client) id &key description focus)
Source

queries.lisp.

Generic Function: update-user-list (client id &key title)

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

Package

tooter-queries.

Methods
Method: update-user-list ((client client) (user-list user-list) &rest args)
Source

queries.lisp.

Method: update-user-list ((client client) (id string) &key title)
Source

queries.lisp.

Generic Reader: updated-at (object)

Update time

See IDENTITY-PROOF

Package

tooter-objects.

Methods
Reader Method: updated-at ((identity-proof identity-proof))

automatically generated reader method

Source

objects.lisp.

Target Slot

updated-at.

Reader Method: updated-at ((announcement announcement))

automatically generated reader method

Source

objects.lisp.

Target Slot

updated-at.

Generic Writer: (setf updated-at) (object)
Package

tooter-objects.

Methods
Writer Method: (setf updated-at) ((identity-proof identity-proof))

automatically generated writer method

Source

objects.lisp.

Target Slot

updated-at.

Writer Method: (setf updated-at) ((announcement announcement))

automatically generated writer method

Source

objects.lisp.

Target Slot

updated-at.

Generic Reader: uri (condition)

Returns the instance’s URI.

See INSTANCE
See STATUS

Package

tooter-objects.

Methods
Reader Method: uri ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

uri.

Reader Method: uri ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

uri.

Reader Method: uri ((condition request-failed))
Source

client.lisp.

Target Slot

uri.

Generic Writer: (setf uri) (object)
Package

tooter-objects.

Methods
Writer Method: (setf uri) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

uri.

Writer Method: (setf uri) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

uri.

Generic Reader: url (object)

Returns if the URL of a custom emoji.

Package

tooter-objects.

Methods
Reader Method: url ((tag tag))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Reader Method: url ((status status))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Reader Method: url ((reaction reaction))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Reader Method: url ((mention mention))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Reader Method: url ((emoji emoji))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Reader Method: url ((card card))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Reader Method: url ((attachment attachment))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Reader Method: url ((announcement-status announcement-status))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Reader Method: url ((announcement-account announcement-account))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Reader Method: url ((account account))

automatically generated reader method

Source

objects.lisp.

Target Slot

url.

Generic Writer: (setf url) (object)
Package

tooter-objects.

Methods
Writer Method: (setf url) ((tag tag))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Writer Method: (setf url) ((status status))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Writer Method: (setf url) ((reaction reaction))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Writer Method: (setf url) ((mention mention))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Writer Method: (setf url) ((emoji emoji))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Writer Method: (setf url) ((card card))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Writer Method: (setf url) ((attachment attachment))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Writer Method: (setf url) ((announcement-status announcement-status))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Writer Method: (setf url) ((announcement-account announcement-account))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Writer Method: (setf url) ((account account))

automatically generated writer method

Source

objects.lisp.

Target Slot

url.

Generic Reader: urls (object)

Returns a list of URLs for the streaming API.

See INSTANCE

Package

tooter-objects.

Methods
Reader Method: urls ((instance instance))

automatically generated reader method

Source

objects.lisp.

Target Slot

urls.

Generic Writer: (setf urls) (object)
Package

tooter-objects.

Methods
Writer Method: (setf urls) ((instance instance))

automatically generated writer method

Source

objects.lisp.

Target Slot

urls.

Generic Reader: use-count (object)

Returns the number of statuses that made use of the hashtag on that day.

See TAG-HISTORY

Package

tooter-objects.

Methods
Reader Method: use-count ((tag-history tag-history))

automatically generated reader method

Source

objects.lisp.

Target Slot

use-count.

Generic Writer: (setf use-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf use-count) ((tag-history tag-history))

automatically generated writer method

Source

objects.lisp.

Target Slot

use-count.

Generic Reader: user-count (object)

Returns the user counts for this instance.

See INSTANCE-STATS

Package

tooter-objects.

Methods
Reader Method: user-count ((instance-stats instance-stats))

automatically generated reader method

Source

objects.lisp.

Target Slot

user-count.

Generic Writer: (setf user-count) (object)
Package

tooter-objects.

Methods
Writer Method: (setf user-count) ((instance-stats instance-stats))

automatically generated writer method

Source

objects.lisp.

Target Slot

user-count.

Generic Function: user-list-accounts (client id &key max-id since-id limit)

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.

See USER-LIST
See CLIENT

Package

tooter-queries.

Methods
Method: user-list-accounts ((client client) (user-list user-list) &rest args)
Source

queri