The tooter Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The tooter Reference Manual

This is the tooter Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Fri May 24 09:54:49 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

About Tooter

This is a client library implementing the full v1 REST API protocol for Mastodon.

How To

Before you start, you'll need an account on some Mastodon instance. For the purposes of this documentation we'll simply pick mastodon.social. Once you've got Tooter loaded you'll first need to create a client instance.

(defvar *client* (make-instance 'tooter:client
                   :base "https://mastodon.social"
                   :name "My Tooter Test App"))

Once you have a client set up, you need to authorise it against your account so that you can make requests on your behalf.

(tooter:authorize *client*)

This will return an URL as its secondary value. Visit this URL in your browser, click on the authorize button, and copy the code it displays. Then call authorize again using this code.

(tooter:authorize *client* "...")

If everything goes well this should return a fully authorised client instance.

(tooter:account *client*)

From here on out you can make use of the full API Mastodon API. See the definition index below.

(tooter:make-status *client* "Tooter works, woah nelly!")

Persisting Client Settings

Once you have authorised your client, you will probably want to save the information somewhere so that the user doesn't need to re-authorise every time. To do this, simply save the key, secret, and access-token values from the client instance. If those are set, the authorize steps are not needed.

Writing an Application Library

If you write an application on top of Mastodon and would like to offer this as another re-usable library, you should create a subclass of client that automatically provides the proper initargs for the :name and so forth. This ensures that your application is known under the correct name, but still lets the user specify the correct :base.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 tooter

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shinmera/tooter

License

Artistic

Description

A client library for Mastodon instances.

Version

1.0.0

Dependencies
Source

tooter.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 tooter.asd

Location

tooter.asd

Systems

tooter (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 tooter/package.lisp

Parent

tooter (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 tooter/toolkit.lisp

Dependency

package.lisp (file)

Parent

tooter (system)

Location

toolkit.lisp

Exported Definitions

plain-format-html (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 tooter/client.lisp

Dependency

toolkit.lisp (file)

Parent

tooter (system)

Location

client.lisp

Exported Definitions
Internal Definitions

%request (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 tooter/objects.lisp

Dependency

client.lisp (file)

Parent

tooter (system)

Location

objects.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 tooter/queries.lisp

Dependency

objects.lisp (file)

Parent

tooter (system)

Location

queries.lisp

Exported Definitions
Internal Definitions

%timeline (function)


Previous: , Up: Lisp files   [Contents][Index]

3.1.7 tooter/documentation.lisp

Dependency

queries.lisp (file)

Parent

tooter (system)

Location

documentation.lisp


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 tooter

Source

package.lisp (file)

Nickname

org.shirakumo.tooter

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.2 tooter-objects

Source

package.lisp (file)

Nickname

org.shirakumo.tooter.objects

Used By List
Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.3 tooter-client

Source

package.lisp (file)

Nickname

org.shirakumo.tooter.client

Use List

tooter-objects

Used By List

tooter

Exported Definitions

Previous: , Up: Packages   [Contents][Index]

4.4 tooter-queries

Source

package.lisp (file)

Nickname

org.shirakumo.tooter.queries

Use List

tooter-objects

Used By List

tooter

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

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

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


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 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 (file)

Method: accept-request (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: access-token OBJECT

Accessor to the access token the client is using to authenticate requestts.

Unless manually filled in, this will be automatically set by AUTHORIZE.

See CLIENT
See AUTHORIZE

Package

tooter-client

Writer

(setf access-token) (generic function)

Methods
Method: access-token (CLIENT client)

automatically generated reader method

Source

client.lisp (file)

Generic Function: (setf access-token) NEW-VALUE OBJECT
Package

tooter-client

Reader

access-token (generic function)

Methods
Method: (setf access-token) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

client.lisp (file)

Generic Function: 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

Writer

(setf account) (generic function)

Methods
Method: account (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Method: account (NOTIFICATION notification)

automatically generated reader method

Source

objects.lisp (file)

Method: account (CLIENT client)
Source

client.lisp (file)

Generic Function: (setf account) NEW-VALUE OBJECT
Package

tooter-objects

Reader

account (generic function)

Methods
Method: (setf account) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf account) NEW-VALUE (NOTIFICATION notification)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf account) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

client.lisp (file)

Generic Function: account-count OBJECT

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

See TAG-HISTORY

Package

tooter-objects

Writer

(setf account-count) (generic function)

Methods
Method: account-count (TAG-HISTORY tag-history)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf account-count) NEW-VALUE OBJECT
Package

tooter-objects

Reader

account-count (generic function)

Methods
Method: (setf account-count) NEW-VALUE (TAG-HISTORY tag-history)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: accounts OBJECT

Returns a list of matching accounts.

See RESULTS

Package

tooter-objects

Writer

(setf accounts) (generic function)

Methods
Method: accounts (RESULTS results)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf accounts) NEW-VALUE OBJECT
Package

tooter-objects

Reader

accounts (generic function)

Methods
Method: (setf accounts) NEW-VALUE (RESULTS results)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: action-taken OBJECT

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

See REPORT

Package

tooter-objects

Writer

(setf action-taken) (generic function)

Methods
Method: action-taken (REPORT report)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf action-taken) NEW-VALUE OBJECT
Package

tooter-objects

Reader

action-taken (generic function)

Methods
Method: (setf action-taken) NEW-VALUE (REPORT report)

automatically generated writer method

Source

objects.lisp (file)

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

Method: add-user-list-accounts (CLIENT client) (ID integer) ACCOUNTS
Source

queries.lisp (file)

Generic Function: alerts OBJECT

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

See PUSH-SUBSCRIPTION

Package

tooter-objects

Writer

(setf alerts) (generic function)

Methods
Method: alerts (PUSH-SUBSCRIPTION push-subscription)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf alerts) NEW-VALUE OBJECT
Package

tooter-objects

Reader

alerts (generic function)

Methods
Method: (setf alerts) NEW-VALUE (PUSH-SUBSCRIPTION push-subscription)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: ancestors OBJECT

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

See CONTEXT

Package

tooter-objects

Writer

(setf ancestors) (generic function)

Methods
Method: ancestors (CONTEXT context)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf ancestors) NEW-VALUE OBJECT
Package

tooter-objects

Reader

ancestors (generic function)

Methods
Method: (setf ancestors) NEW-VALUE (CONTEXT context)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: application OBJECT

Returns the application with which this status was made.

See STATUS
See APPLICATION

Package

tooter-objects

Writer

(setf application) (generic function)

Methods
Method: application (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf application) NEW-VALUE OBJECT
Package

tooter-objects

Reader

application (generic function)

Methods
Method: (setf application) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: aspect OBJECT

Returns the aspect ratio of the image.

See IMAGE-METADATA

Package

tooter-objects

Writer

(setf aspect) (generic function)

Methods
Method: aspect (IMAGE-METADATA image-metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf aspect) NEW-VALUE OBJECT
Package

tooter-objects

Reader

aspect (generic function)

Methods
Method: (setf aspect) NEW-VALUE (IMAGE-METADATA image-metadata)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: author-name OBJECT

Returns the name of the status’ author.

See CARD

Package

tooter-objects

Writer

(setf author-name) (generic function)

Methods
Method: author-name (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf author-name) NEW-VALUE OBJECT
Package

tooter-objects

Reader

author-name (generic function)

Methods
Method: (setf author-name) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: author-url OBJECT

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

See CARD

Package

tooter-objects

Writer

(setf author-url) (generic function)

Methods
Method: author-url (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf author-url) NEW-VALUE OBJECT
Package

tooter-objects

Reader

author-url (generic function)

Methods
Method: (setf author-url) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

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

Generic Function: avatar OBJECT

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

This may be an animated image.

See ACCOUNT

Package

tooter-objects

Writer

(setf avatar) (generic function)

Methods
Method: avatar (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf avatar) NEW-VALUE OBJECT
Package

tooter-objects

Reader

avatar (generic function)

Methods
Method: (setf avatar) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: avatar-static OBJECT

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

See ACCOUNT

Package

tooter-objects

Writer

(setf avatar-static) (generic function)

Methods
Method: avatar-static (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf avatar-static) NEW-VALUE OBJECT
Package

tooter-objects

Reader

avatar-static (generic function)

Methods
Method: (setf avatar-static) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: 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

Writer

(setf base) (generic function)

Methods
Method: base (CLIENT client)

automatically generated reader method

Source

client.lisp (file)

Generic Function: (setf base) NEW-VALUE OBJECT
Package

tooter-client

Reader

base (generic function)

Methods
Method: (setf base) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

client.lisp (file)

Generic Function: bitrate OBJECT

Returns the bitrate of the video in ???.

See VIDEO-METADATA

Package

tooter-objects

Writer

(setf bitrate) (generic function)

Methods
Method: bitrate (VIDEO-METADATA video-metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf bitrate) NEW-VALUE OBJECT
Package

tooter-objects

Reader

bitrate (generic function)

Methods
Method: (setf bitrate) NEW-VALUE (VIDEO-METADATA video-metadata)

automatically generated writer method

Source

objects.lisp (file)

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

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

queries.lisp (file)

Method: block (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

Generic Function: blocking OBJECT

Returns whether the account is blocked by you.

See RELATIONSHIP

Package

tooter-objects

Writer

(setf blocking) (generic function)

Methods
Method: blocking (RELATIONSHIP relationship)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf blocking) NEW-VALUE OBJECT
Package

tooter-objects

Reader

blocking (generic function)

Methods
Method: (setf blocking) NEW-VALUE (RELATIONSHIP relationship)

automatically generated writer method

Source

objects.lisp (file)

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

Generic Function: bot OBJECT

Returns whether the account is a bot.

See ACCOUNT

Package

tooter-objects

Writer

(setf bot) (generic function)

Methods
Method: bot (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf bot) NEW-VALUE OBJECT
Package

tooter-objects

Reader

bot (generic function)

Methods
Method: (setf bot) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

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

Method: card (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: code CONDITION

Returns the HTTP return code for the failed request.

See REQUEST-FAILED

Package

tooter-client

Methods
Method: code (CONDITION request-failed)
Source

client.lisp (file)

Generic Function: contact-account OBJECT

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

See INSTANCE

Package

tooter-objects

Writer

(setf contact-account) (generic function)

Methods
Method: contact-account (INSTANCE instance)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf contact-account) NEW-VALUE OBJECT
Package

tooter-objects

Reader

contact-account (generic function)

Methods
Method: (setf contact-account) NEW-VALUE (INSTANCE instance)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: content OBJECT

Returns the status’ content as an HTML string.

See STATUS

Package

tooter-objects

Writer

(setf content) (generic function)

Methods
Method: content (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf content) NEW-VALUE OBJECT
Package

tooter-objects

Reader

content (generic function)

Methods
Method: (setf content) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

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

Method: context (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: created-at OBJECT

Returns the universal-time timestamp on which the given object was created.

See ACCOUNT
See NOTIFICATION
See STATUS

Package

tooter-objects

Writer

(setf created-at) (generic function)

Methods
Method: created-at (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Method: created-at (NOTIFICATION notification)

automatically generated reader method

Source

objects.lisp (file)

Method: created-at (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf created-at) NEW-VALUE OBJECT
Package

tooter-objects

Reader

created-at (generic function)

Methods
Method: (setf created-at) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf created-at) NEW-VALUE (NOTIFICATION notification)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf created-at) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: data CONDITION

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

See REQUEST-FAILED

Package

tooter-client

Methods
Method: data (CONDITION request-failed)
Source

client.lisp (file)

Generic Function: day OBJECT

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

See TAG-HISTORY

Package

tooter-objects

Writer

(setf day) (generic function)

Methods
Method: day (TAG-HISTORY tag-history)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf day) NEW-VALUE OBJECT
Package

tooter-objects

Reader

day (generic function)

Methods
Method: (setf day) NEW-VALUE (TAG-HISTORY tag-history)

automatically generated writer method

Source

objects.lisp (file)

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

Methods
Method: decode-entity (TAG-HISTORY tag-history) DATA0
Method: decode-entity (TAG tag) DATA0
Method: decode-entity (STATUS status) DATA0
Method: decode-entity (RESULTS results) DATA0
Method: decode-entity (REPORT report) DATA0
Method: decode-entity (RELATIONSHIP relationship) DATA0
Method: decode-entity (PUSH-SUBSCRIPTION push-subscription) DATA0
Method: decode-entity (NOTIFICATION notification) DATA0
Method: decode-entity (MENTION mention) DATA0
Method: decode-entity (USER-LIST user-list) DATA0
Method: decode-entity (INSTANCE instance) DATA0
Method: decode-entity (EMOJI emoji) DATA0
Method: decode-entity (CONTEXT context) DATA0
Method: decode-entity (CARD card) 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 (ACCOUNT account) DATA0
Method: decode-entity (TYPE symbol) (DATA list)
Method: decode-entity (TYPE symbol) DATA
Generic Function: default-headers CLIENT

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

See CLIENT

Package

tooter-client

Methods
Method: default-headers (CLIENT client)
Source

client.lisp (file)

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

Method: delete-notification (CLIENT client) (ID integer)
Source

queries.lisp (file)

Method: delete-notification (CLIENT client) (ALL (eql t))
Source

queries.lisp (file)

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

Method: delete-status (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

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

queries.lisp (file)

Generic Function: descendants OBJECT

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

See CONTEXT

Package

tooter-objects

Writer

(setf descendants) (generic function)

Methods
Method: descendants (CONTEXT context)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf descendants) NEW-VALUE OBJECT
Package

tooter-objects

Reader

descendants (generic function)

Methods
Method: (setf descendants) NEW-VALUE (CONTEXT context)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: description OBJECT

Returns a textual description of the contents of the object.

See ATTACHMENT
See CARD
See INSTANCE

Package

tooter-objects

Writer

(setf description) (generic function)

Methods
Method: description (INSTANCE instance)

automatically generated reader method

Source

objects.lisp (file)

Method: description (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Method: description (ATTACHMENT attachment)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf description) NEW-VALUE OBJECT
Package

tooter-objects

Reader

description (generic function)

Methods
Method: (setf description) NEW-VALUE (INSTANCE instance)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf description) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf description) NEW-VALUE (ATTACHMENT attachment)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: display-name OBJECT

Returns the display name of the account.

See ACCOUNT

Package

tooter-objects

Writer

(setf display-name) (generic function)

Methods
Method: display-name (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf display-name) NEW-VALUE OBJECT
Package

tooter-objects

Reader

display-name (generic function)

Methods
Method: (setf display-name) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: domain-blocking OBJECT

Returns whether you are blocking the account’s domain.

See RELATIONSHIP

Package

tooter-objects

Writer

(setf domain-blocking) (generic function)

Methods
Method: domain-blocking (RELATIONSHIP relationship)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf domain-blocking) NEW-VALUE OBJECT
Package

tooter-objects

Reader

domain-blocking (generic function)

Methods
Method: (setf domain-blocking) NEW-VALUE (RELATIONSHIP relationship)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: duration OBJECT

Returns the duration of the video in seconds.

See VIDEO-METADATA

Package

tooter-objects

Writer

(setf duration) (generic function)

Methods
Method: duration (VIDEO-METADATA video-metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf duration) NEW-VALUE OBJECT
Package

tooter-objects

Reader

duration (generic function)

Methods
Method: (setf duration) NEW-VALUE (VIDEO-METADATA video-metadata)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: email OBJECT

Returns the primary contact email address for the instance.

See INSTANCE

Package

tooter-objects

Writer

(setf email) (generic function)

Methods
Method: email (INSTANCE instance)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf email) NEW-VALUE OBJECT
Package

tooter-objects

Reader

email (generic function)

Methods
Method: (setf email) NEW-VALUE (INSTANCE instance)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: emojis OBJECT

Retrieve a list of custom emojis present on the instance.

See CLIENT
See EOMJI

Package

tooter-objects

Writer

(setf emojis) (generic function)

Methods
Method: emojis (CLIENT client)
Source

queries.lisp (file)

Method: emojis (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf emojis) NEW-VALUE OBJECT
Package

tooter-objects

Reader

emojis (generic function)

Methods
Method: (setf emojis) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: endpoint OBJECT

The endpoint URL to which push notifications are delivered.

See PUSH-SUBSCRIPTION

Package

tooter-objects

Writer

(setf endpoint) (generic function)

Methods
Method: endpoint (PUSH-SUBSCRIPTION push-subscription)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf endpoint) NEW-VALUE OBJECT
Package

tooter-objects

Reader

endpoint (generic function)

Methods
Method: (setf endpoint) NEW-VALUE (PUSH-SUBSCRIPTION push-subscription)

automatically generated writer method

Source

objects.lisp (file)

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

Method: favourite (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: favourited OBJECT

Returns whether you have favourited this status.

See STATUS

Package

tooter-objects

Writer

(setf favourited) (generic function)

Methods
Method: favourited (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf favourited) NEW-VALUE OBJECT
Package

tooter-objects

Reader

favourited (generic function)

Methods
Method: (setf favourited) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

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

Method: favouriters (CLIENT client) (ID integer) &key MAX-ID SINCE-ID LIMIT
Source

queries.lisp (file)

Generic Function: favourites CLIENT &key MAX-ID SINCE-ID LIMIT

Retrieve a list of favourited statuses.

See CLIENT
See STATUS

Package

tooter-queries

Methods
Method: favourites (CLIENT client) &key MAX-ID SINCE-ID LIMIT
Source

queries.lisp (file)

Generic Function: favourites-count OBJECT

Returns the number of favourites this status has received.

See STATUS

Package

tooter-objects

Writer

(setf favourites-count) (generic function)

Methods
Method: favourites-count (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf favourites-count) NEW-VALUE OBJECT
Package

tooter-objects

Reader

favourites-count (generic function)

Methods
Method: (setf favourites-count) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: fields OBJECT

Returns an alist of account profile fields.

This list is limited to a maximum of four fields.
The fields have custom keys and values that the user can specify.

See ACCOUNT

Package

tooter-objects

Writer

(setf fields) (generic function)

Methods
Method: fields (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf fields) NEW-VALUE OBJECT
Package

tooter-objects

Reader

fields (generic function)

Methods
Method: (setf fields) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

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

queries.lisp (file)

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

queries.lisp (file)

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

queries.lisp (file)

Generic Function: find-results CLIENT QUERY &key RESOLVE

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 RESOLVE
Source

queries.lisp (file)

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

queries.lisp (file)

Generic Function: 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

Writer

(setf focus) (generic function)

Methods
Method: focus (METADATA metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf focus) NEW-VALUE OBJECT
Package

tooter-objects

Reader

focus (generic function)

Methods
Method: (setf focus) NEW-VALUE (METADATA metadata)

automatically generated writer method

Source

objects.lisp (file)

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) (URI string)
Source

queries.lisp (file)

Method: follow (CLIENT client) (ACCOUNT account)
Source

queries.lisp (file)

Method: follow (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: follow-remote CLIENT URI

Follow a remote account.

Typically you do not need to use this function, as FOLLOW automatically performs the correct action.

Returns the local representation of the followed account.

See FOLLOW
See CLIENT
See ACCOUNT

Package

tooter-queries

Methods
Method: follow-remote (CLIENT client) (ACCOUNT account)
Source

queries.lisp (file)

Method: follow-remote (CLIENT client) (URI string)
Source

queries.lisp (file)

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

Generic Function: followed-by OBJECT

Returns whether the account is following you.

See RELATIONSHIP

Package

tooter-objects

Writer

(setf followed-by) (generic function)

Methods
Method: followed-by (RELATIONSHIP relationship)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf followed-by) NEW-VALUE OBJECT
Package

tooter-objects

Reader

followed-by (generic function)

Methods
Method: (setf followed-by) NEW-VALUE (RELATIONSHIP relationship)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: followers-count OBJECT

Returns the number of followers the account has.

See ACCOUNT

Package

tooter-objects

Writer

(setf followers-count) (generic function)

Methods
Method: followers-count (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf followers-count) NEW-VALUE OBJECT
Package

tooter-objects

Reader

followers-count (generic function)

Methods
Method: (setf followers-count) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: following OBJECT

Returns whether you are following this account.

See RELATIONSHIP

Package

tooter-objects

Writer

(setf following) (generic function)

Methods
Method: following (RELATIONSHIP relationship)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf following) NEW-VALUE OBJECT
Package

tooter-objects

Reader

following (generic function)

Methods
Method: (setf following) NEW-VALUE (RELATIONSHIP relationship)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: following-count OBJECT

Returns the number of users this account is following.

See ACCOUNT

Package

tooter-objects

Writer

(setf following-count) (generic function)

Methods
Method: following-count (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf following-count) NEW-VALUE OBJECT
Package

tooter-objects

Reader

following-count (generic function)

Methods
Method: (setf following-count) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: frame-rate OBJECT

Returns the frame-rate of the video in FPS.

See VIDEO-METADATA

Package

tooter-objects

Writer

(setf frame-rate) (generic function)

Methods
Method: frame-rate (VIDEO-METADATA video-metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf frame-rate) NEW-VALUE OBJECT
Package

tooter-objects

Reader

frame-rate (generic function)

Methods
Method: (setf frame-rate) NEW-VALUE (VIDEO-METADATA video-metadata)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: get-followers CLIENT ID &key MAX-ID SINCE-ID LIMIT

Return 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 (file)

Method: get-followers (CLIENT client) (ACCOUNT account) &rest ARGS
Source

queries.lisp (file)

Method: get-followers (CLIENT client) (ID integer) &key MAX-ID SINCE-ID LIMIT
Source

queries.lisp (file)

Generic Function: get-following CLIENT ID &key MAX-ID SINCE-ID LIMIT

Return 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 (file)

Method: get-following (CLIENT client) (ACCOUNT account) &rest ARGS
Source

queries.lisp (file)

Method: get-following (CLIENT client) (ID integer) &key MAX-ID SINCE-ID LIMIT
Source

queries.lisp (file)

Generic Function: get-statuses CLIENT ID &key ONLY-MEDIA PINNED EXCLUDE-REPLIES MAX-ID SINCE-ID LIMIT

Return 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 (file)

Method: get-statuses (CLIENT client) (ACCOUNT account) &rest ARGS
Source

queries.lisp (file)

Method: get-statuses (CLIENT client) (ID integer) &key ONLY-MEDIA PINNED EXCLUDE-REPLIES MAX-ID SINCE-ID LIMIT
Source

queries.lisp (file)

Generic Function: hashtags OBJECT

Returns a list of matching hashtags as strings.

See RESULTS

Package

tooter-objects

Writer

(setf hashtags) (generic function)

Methods
Method: hashtags (RESULTS results)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf hashtags) NEW-VALUE OBJECT
Package

tooter-objects

Reader

hashtags (generic function)

Methods
Method: (setf hashtags) NEW-VALUE (RESULTS results)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: header OBJECT

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

This may be an animated image.

See ACCOUNT

Package

tooter-objects

Writer

(setf header) (generic function)

Methods
Method: header (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf header) NEW-VALUE OBJECT
Package

tooter-objects

Reader

header (generic function)

Methods
Method: (setf header) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: header-static OBJECT

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

See ACCOUNT

Package

tooter-objects

Writer

(setf header-static) (generic function)

Methods
Method: header-static (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf header-static) NEW-VALUE OBJECT
Package

tooter-objects

Reader

header-static (generic function)

Methods
Method: (setf header-static) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: height OBJECT

Returns the height of the media or card.

See CARD
See IMAGE-METADATA
See VIDEO-METADATA

Package

tooter-objects

Writer

(setf height) (generic function)

Methods
Method: height (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Method: height (VIDEO-METADATA video-metadata)

automatically generated reader method

Source

objects.lisp (file)

Method: height (IMAGE-METADATA image-metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf height) NEW-VALUE OBJECT
Package

tooter-objects

Reader

height (generic function)

Methods
Method: (setf height) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf height) NEW-VALUE (VIDEO-METADATA video-metadata)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf height) NEW-VALUE (IMAGE-METADATA image-metadata)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: history OBJECT

Returns an array describing daily usage information of the hashtag.

See TAG
See TAG-HISTORY

Package

tooter-objects

Writer

(setf history) (generic function)

Methods
Method: history (TAG tag)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf history) NEW-VALUE OBJECT
Package

tooter-objects

Reader

history (generic function)

Methods
Method: (setf history) NEW-VALUE (TAG tag)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: html OBJECT

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

See CARD

Package

tooter-objects

Writer

(setf html) (generic function)

Methods
Method: html (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf html) NEW-VALUE OBJECT
Package

tooter-objects

Reader

html (generic function)

Methods
Method: (setf html) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: id OBJECT

Returns the numerical ID of the object.

This ID is used in the API to query the object itself, or properties related to it.

See ACCOUNT
See ATTACHMENT
See USER-LIST
See MENTION
See NOTIFICATION
See PUSH-SUBSCRIPTION
See RELATIONSHIP
See REPORT
See STATUS

Package

tooter-objects

Writer

(setf id) (generic function)

Methods
Method: id (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Method: id (REPORT report)

automatically generated reader method

Source

objects.lisp (file)

Method: id (RELATIONSHIP relationship)

automatically generated reader method

Source

objects.lisp (file)

Method: id (PUSH-SUBSCRIPTION push-subscription)

automatically generated reader method

Source

objects.lisp (file)

Method: id (NOTIFICATION notification)

automatically generated reader method

Source

objects.lisp (file)

Method: id (MENTION mention)

automatically generated reader method

Source

objects.lisp (file)

Method: id (USER-LIST user-list)

automatically generated reader method

Source

objects.lisp (file)

Method: id (ATTACHMENT attachment)

automatically generated reader method

Source

objects.lisp (file)

Method: id (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf id) NEW-VALUE OBJECT
Package

tooter-objects

Reader

id (generic function)

Methods
Method: (setf id) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf id) NEW-VALUE (REPORT report)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf id) NEW-VALUE (RELATIONSHIP relationship)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf id) NEW-VALUE (PUSH-SUBSCRIPTION push-subscription)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf id) NEW-VALUE (NOTIFICATION notification)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf id) NEW-VALUE (MENTION mention)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf id) NEW-VALUE (USER-LIST user-list)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf id) NEW-VALUE (ATTACHMENT attachment)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf id) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: image OBJECT

Returns the URL of the card’s image, if any.

See CARD

Package

tooter-objects

Writer

(setf image) (generic function)

Methods
Method: image (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf image) NEW-VALUE OBJECT
Package

tooter-objects

Reader

image (generic function)

Methods
Method: (setf image) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: in-reply-to-account-id OBJECT

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

See STATUS

Package

tooter-objects

Writer

(setf in-reply-to-account-id) (generic function)

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

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf in-reply-to-account-id) NEW-VALUE OBJECT
Package

tooter-objects

Reader

in-reply-to-account-id (generic function)

Methods
Method: (setf in-reply-to-account-id) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: in-reply-to-id OBJECT

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

See STATUS

Package

tooter-objects

Writer

(setf in-reply-to-id) (generic function)

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

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf in-reply-to-id) NEW-VALUE OBJECT
Package

tooter-objects

Reader

in-reply-to-id (generic function)

Methods
Method: (setf in-reply-to-id) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

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

Generic Function: 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

Writer

(setf key) (generic function)

Methods
Method: key (CLIENT client)

automatically generated reader method

Source

client.lisp (file)

Generic Function: (setf key) NEW-VALUE OBJECT
Package

tooter-client

Reader

key (generic function)

Methods
Method: (setf key) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

client.lisp (file)

Generic Function: kind OBJECT

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

See ATTACHMENT
See CARD
See NOTIFICATION

Package

tooter-objects

Writer

(setf kind) (generic function)

Methods
Method: kind (NOTIFICATION notification)

automatically generated reader method

Source

objects.lisp (file)

Method: kind (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Method: kind (ATTACHMENT attachment)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf kind) NEW-VALUE OBJECT
Package

tooter-objects

Reader

kind (generic function)

Methods
Method: (setf kind) NEW-VALUE (NOTIFICATION notification)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf kind) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf kind) NEW-VALUE (ATTACHMENT attachment)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: language OBJECT

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

See STATUS

Package

tooter-objects

Writer

(setf language) (generic function)

Methods
Method: language (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf language) NEW-VALUE OBJECT
Package

tooter-objects

Reader

language (generic function)

Methods
Method: (setf language) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: languages OBJECT

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

See INSTANCE

Package

tooter-objects

Writer

(setf languages) (generic function)

Methods
Method: languages (INSTANCE instance)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf languages) NEW-VALUE OBJECT
Package

tooter-objects

Reader

languages (generic function)

Methods
Method: (setf languages) NEW-VALUE (INSTANCE instance)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: locked OBJECT

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

See ACCOUNT

Package

tooter-objects

Writer

(setf locked) (generic function)

Methods
Method: locked (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf locked) NEW-VALUE OBJECT
Package

tooter-objects

Reader

locked (generic function)

Methods
Method: (setf locked) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

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

Generic Function: make-report CLIENT ID &key STATUSES COMMENT

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

Method: make-report (CLIENT client) (ID integer) &key STATUSES COMMENT
Source

queries.lisp (file)

Generic Function: make-status CLIENT STATUS &key IN-REPLY-TO MEDIA SENSITIVE SPOILER-TEXT VISIBILITY LANGUAGE

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.

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
Source

queries.lisp (file)

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

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

Generic Function: media-attachments OBJECT

Returns a list of up to four media attachments.

See ATTACHMENT
See STATUS

Package

tooter-objects

Writer

(setf media-attachments) (generic function)

Methods
Method: media-attachments (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf media-attachments) NEW-VALUE OBJECT
Package

tooter-objects

Reader

media-attachments (generic function)

Methods
Method: (setf media-attachments) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: mentions OBJECT

Returns an array of mentions used in the status.

See STATUS
See MENTION

Package

tooter-objects

Writer

(setf mentions) (generic function)

Methods
Method: mentions (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf mentions) NEW-VALUE OBJECT
Package

tooter-objects

Reader

mentions (generic function)

Methods
Method: (setf mentions) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: message CONDITION

Returns the error message string for the failed request.

See REQUEST-FAILED

Package

tooter-client

Methods
Method: message (CONDITION request-failed)
Source

client.lisp (file)

Generic Function: metadata OBJECT

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

See ATTACHMENT

Package

tooter-objects

Writer

(setf metadata) (generic function)

Methods
Method: metadata (ATTACHMENT attachment)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf metadata) NEW-VALUE OBJECT
Package

tooter-objects

Reader

metadata (generic function)

Methods
Method: (setf metadata) NEW-VALUE (ATTACHMENT attachment)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: moved OBJECT

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

See ACCOUNT

Package

tooter-objects

Writer

(setf moved) (generic function)

Methods
Method: moved (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf moved) NEW-VALUE OBJECT
Package

tooter-objects

Reader

moved (generic function)

Methods
Method: (setf moved) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

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

Method: mute (CLIENT client) (ACCOUNT account) &rest ARGS
Source

queries.lisp (file)

Method: mute (CLIENT client) (ID integer) &key NOTIFICATIONS
Source

queries.lisp (file)

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

Method: mute-conversation (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: muted OBJECT

Returns whether this status should be muted.

See STATUS

Package

tooter-objects

Writer

(setf muted) (generic function)

Methods
Method: muted (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf muted) NEW-VALUE OBJECT
Package

tooter-objects

Reader

muted (generic function)

Methods
Method: (setf muted) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

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

Generic Function: muting OBJECT

Returns whether the account is muted by you.

See RELATIONSHIP

Package

tooter-objects

Writer

(setf muting) (generic function)

Methods
Method: muting (RELATIONSHIP relationship)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf muting) NEW-VALUE OBJECT
Package

tooter-objects

Reader

muting (generic function)

Methods
Method: (setf muting) NEW-VALUE (RELATIONSHIP relationship)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: muting-notifications OBJECT

Returns whether notifications from the account are muted by you.

See RELATIONSHIP

Package

tooter-objects

Writer

(setf muting-notifications) (generic function)

Methods
Method: muting-notifications (RELATIONSHIP relationship)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf muting-notifications) NEW-VALUE OBJECT
Package

tooter-objects

Reader

muting-notifications (generic function)

Methods
Method: (setf muting-notifications) NEW-VALUE (RELATIONSHIP relationship)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: name OBJECT

Returns the name of the object.

See CLIENT
See APPLICATION
See TAG

Package

tooter-objects

Writer

(setf name) (generic function)

Methods
Method: name (TAG tag)

automatically generated reader method

Source

objects.lisp (file)

Method: name (APPLICATION application)

automatically generated reader method

Source

objects.lisp (file)

Method: name (CLIENT client)

automatically generated reader method

Source

client.lisp (file)

Generic Function: (setf name) NEW-VALUE OBJECT
Package

tooter-objects

Reader

name (generic function)

Methods
Method: (setf name) NEW-VALUE (TAG tag)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf name) NEW-VALUE (APPLICATION application)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf name) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

client.lisp (file)

Generic Function: note OBJECT

Returns the account’s note or description.

See ACCOUNT

Package

tooter-objects

Writer

(setf note) (generic function)

Methods
Method: note (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf note) NEW-VALUE OBJECT
Package

tooter-objects

Reader

note (generic function)

Methods
Method: (setf note) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: notifications CLIENT &key MAX-ID SINCE-ID LIMIT EXCLUDE-TYPES

Returns a list of notifications about status updates.

See NOTIFICATION
See CLIENT

Package

tooter-queries

Methods
Method: notifications (CLIENT client) &key MAX-ID SINCE-ID LIMIT EXCLUDE-TYPES
Source

queries.lisp (file)

Generic Function: 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

Writer

(setf original) (generic function)

Methods
Method: original (METADATA metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf original) NEW-VALUE OBJECT
Package

tooter-objects

Reader

original (generic function)

Methods
Method: (setf original) NEW-VALUE (METADATA metadata)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: parent OBJECT

Returns the original status this status is a reblog of.

See STATUS

Package

tooter-objects

Writer

(setf parent) (generic function)

Methods
Method: parent (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf parent) NEW-VALUE OBJECT
Package

tooter-objects

Reader

parent (generic function)

Methods
Method: (setf parent) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

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

Method: pin (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: pinned OBJECT

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

See STATUS

Package

tooter-objects

Writer

(setf pinned) (generic function)

Methods
Method: pinned (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf pinned) NEW-VALUE OBJECT
Package

tooter-objects

Reader

pinned (generic function)

Methods
Method: (setf pinned) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: preview-url OBJECT

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

See ATTACHMENT

Package

tooter-objects

Writer

(setf preview-url) (generic function)

Methods
Method: preview-url (ATTACHMENT attachment)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf preview-url) NEW-VALUE OBJECT
Package

tooter-objects

Reader

preview-url (generic function)

Methods
Method: (setf preview-url) NEW-VALUE (ATTACHMENT attachment)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: provider-name OBJECT

Returns the name of the status’ instance.

See CARD

Package

tooter-objects

Writer

(setf provider-name) (generic function)

Methods
Method: provider-name (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf provider-name) NEW-VALUE OBJECT
Package

tooter-objects

Reader

provider-name (generic function)

Methods
Method: (setf provider-name) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: provider-url OBJECT

Returns the URL to the status’ instance.

See CARD

Package

tooter-objects

Writer

(setf provider-url) (generic function)

Methods
Method: provider-url (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf provider-url) NEW-VALUE OBJECT
Package

tooter-objects

Reader

provider-url (generic function)

Methods
Method: (setf provider-url) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

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

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

Method: reblog (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: reblogged OBJECT

Returns whether you have reblogged this status.

See STATUS

Package

tooter-objects

Writer

(setf reblogged) (generic function)

Methods
Method: reblogged (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf reblogged) NEW-VALUE OBJECT
Package

tooter-objects

Reader

reblogged (generic function)

Methods
Method: (setf reblogged) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

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

Method: rebloggers (CLIENT client) (ID integer) &key MAX-ID SINCE-ID LIMIT
Source

queries.lisp (file)

Generic Function: reblogs-count OBJECT

Returns the number of reblogs this status has received.

See STATUS

Package

tooter-objects

Writer

(setf reblogs-count) (generic function)

Methods
Method: reblogs-count (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf reblogs-count) NEW-VALUE OBJECT
Package

tooter-objects

Reader

reblogs-count (generic function)

Methods
Method: (setf reblogs-count) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: 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

Writer

(setf redirect) (generic function)

Methods
Method: redirect (CLIENT client)

automatically generated reader method

Source

client.lisp (file)

Generic Function: (setf redirect) NEW-VALUE OBJECT
Package

tooter-client

Reader

redirect (generic function)

Methods
Method: (setf redirect) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

client.lisp (file)

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

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

Method: reject-request (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

Method: relationships (CLIENT client) (IDS cons)
Source

queries.lisp (file)

Generic Function: remote-url OBJECT

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

See ATTACHMENT

Package

tooter-objects

Writer

(setf remote-url) (generic function)

Methods
Method: remote-url (ATTACHMENT attachment)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf remote-url) NEW-VALUE OBJECT
Package

tooter-objects

Reader

remote-url (generic function)

Methods
Method: (setf remote-url) NEW-VALUE (ATTACHMENT attachment)

automatically generated writer method

Source

objects.lisp (file)

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

Method: remove-user-list-accounts (CLIENT client) (ID integer) ACCOUNTS
Source

queries.lisp (file)

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

Generic Function: requested OBJECT

Returns whether you have requested a follow to the account.

See RELATIONSHIP

Package

tooter-objects

Writer

(setf requested) (generic function)

Methods
Method: requested (RELATIONSHIP relationship)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf requested) NEW-VALUE OBJECT
Package

tooter-objects

Reader

requested (generic function)

Methods
Method: (setf requested) NEW-VALUE (RELATIONSHIP relationship)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: 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

Writer

(setf scopes) (generic function)

Methods
Method: scopes (CLIENT client)

automatically generated reader method

Source

client.lisp (file)

Generic Function: (setf scopes) NEW-VALUE OBJECT
Package

tooter-client

Reader

scopes (generic function)

Methods
Method: (setf scopes) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

client.lisp (file)

Generic Function: search-accounts CLIENT QUERY &key LIMIT FOLLOWING

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
Source

queries.lisp (file)

Generic Function: 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

Writer

(setf secret) (generic function)

Methods
Method: secret (CLIENT client)

automatically generated reader method

Source

client.lisp (file)

Generic Function: (setf secret) NEW-VALUE OBJECT
Package

tooter-client

Reader

secret (generic function)

Methods
Method: (setf secret) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

client.lisp (file)

Generic Function: sensitive OBJECT

Returns whether this status contains sensitive media attachments.

See STATUS

Package

tooter-objects

Writer

(setf sensitive) (generic function)

Methods
Method: sensitive (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf sensitive) NEW-VALUE OBJECT
Package

tooter-objects

Reader

sensitive (generic function)

Methods
Method: (setf sensitive) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: server-key OBJECT

The public key signature for verification of deliveries.

See PUSH-SUBSCRIPTION

Package

tooter-objects

Writer

(setf server-key) (generic function)

Methods
Method: server-key (PUSH-SUBSCRIPTION push-subscription)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf server-key) NEW-VALUE OBJECT
Package

tooter-objects

Reader

server-key (generic function)

Methods
Method: (setf server-key) NEW-VALUE (PUSH-SUBSCRIPTION push-subscription)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: shortcode OBJECT

Returns the short code to display the emoji.

See EMOJI

Package

tooter-objects

Writer

(setf shortcode) (generic function)

Methods
Method: shortcode (EMOJI emoji)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf shortcode) NEW-VALUE OBJECT
Package

tooter-objects

Reader

shortcode (generic function)

Methods
Method: (setf shortcode) NEW-VALUE (EMOJI emoji)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: size OBJECT

Returns the size of the image.

See IMAGE-METADATA

Package

tooter-objects

Writer

(setf size) (generic function)

Methods
Method: size (IMAGE-METADATA image-metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf size) NEW-VALUE OBJECT
Package

tooter-objects

Reader

size (generic function)

Methods
Method: (setf size) NEW-VALUE (IMAGE-METADATA image-metadata)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: 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

Writer

(setf small) (generic function)

Methods
Method: small (METADATA metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf small) NEW-VALUE OBJECT
Package

tooter-objects

Reader

small (generic function)

Methods
Method: (setf small) NEW-VALUE (METADATA metadata)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: 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

Writer

(setf source) (generic function)

Methods
Method: source (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf source) NEW-VALUE OBJECT
Package

tooter-objects

Reader

source (generic function)

Methods
Method: (setf source) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: spoiler-text OBJECT

Returns the spoiler text for the status.

See STATUS

Package

tooter-objects

Writer

(setf spoiler-text) (generic function)

Methods
Method: spoiler-text (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf spoiler-text) NEW-VALUE OBJECT
Package

tooter-objects

Reader

spoiler-text (generic function)

Methods
Method: (setf spoiler-text) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: static-url OBJECT

Returns the static image of the emoji.

See EMOJI

Package

tooter-objects

Writer

(setf static-url) (generic function)

Methods
Method: static-url (EMOJI emoji)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf static-url) NEW-VALUE OBJECT
Package

tooter-objects

Reader

static-url (generic function)

Methods
Method: (setf static-url) NEW-VALUE (EMOJI emoji)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: status OBJECT

Returns the status the notification is about.

See NOTIFICATION

Package

tooter-objects

Writer

(setf status) (generic function)

Methods
Method: status (NOTIFICATION notification)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf status) NEW-VALUE OBJECT
Package

tooter-objects

Reader

status (generic function)

Methods
Method: (setf status) NEW-VALUE (NOTIFICATION notification)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: statuses OBJECT

Returns a list of matching statuses.

See RESULTS

Package

tooter-objects

Writer

(setf statuses) (generic function)

Methods
Method: statuses (RESULTS results)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf statuses) NEW-VALUE OBJECT
Package

tooter-objects

Reader

statuses (generic function)

Methods
Method: (setf statuses) NEW-VALUE (RESULTS results)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: statuses-count OBJECT

Returns the number of statuses the account has made.

See ACCOUNT

Package

tooter-objects

Writer

(setf statuses-count) (generic function)

Methods
Method: statuses-count (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf statuses-count) NEW-VALUE OBJECT
Package

tooter-objects

Reader

statuses-count (generic function)

Methods
Method: (setf statuses-count) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

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.

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

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

Generic Function: tags OBJECT

Returns an array of tags used in the status.

See STATUS
See TAG

Package

tooter-objects

Writer

(setf tags) (generic function)

Methods
Method: tags (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf tags) NEW-VALUE OBJECT
Package

tooter-objects

Reader

tags (generic function)

Methods
Method: (setf tags) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: 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

Writer

(setf text-url) (generic function)

Methods
Method: text-url (ATTACHMENT attachment)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf text-url) NEW-VALUE OBJECT
Package

tooter-objects

Reader

text-url (generic function)

Methods
Method: (setf text-url) NEW-VALUE (ATTACHMENT attachment)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: timeline CLIENT KIND &key LOCAL ONLY-MEDIA MAX-ID SINCE-ID

Return statuses for the specified timeline.

The KIND can be one of the following:
:HOME — Return statuses for your home timeline. This includes your own and statuses of all accounts you follow. :PUBLIC — Return statuses for your instance’s public timeline. STRING — Return statuses for the given hashtag.
INTEGER — Return statuses for the given user-list’s accounts. USER-LIST — Return statuses for the given user-list’s accounts.

See STATUS
See CLIENT
See USER-LIST

Package

tooter-queries

Source

queries.lisp (file)

Methods
Method: timeline (CLIENT client) (USER-LIST user-list) &rest ARGS
Method: timeline (CLIENT client) (TAG tag) &rest ARGS
Method: timeline (CLIENT client) (ID integer) &rest ARGS
Method: timeline (CLIENT client) (TAG string) &rest ARGS
Method: timeline (CLIENT client) (KIND (eql public)) &rest ARGS
Method: timeline (CLIENT client) (KIND (eql home)) &rest ARGS
Generic Function: title OBJECT

Returns the title of the object.

See CARD
See INSTANCE
See USER-LIST

Package

tooter-objects

Writer

(setf title) (generic function)

Methods
Method: title (USER-LIST user-list)

automatically generated reader method

Source

objects.lisp (file)

Method: title (INSTANCE instance)

automatically generated reader method

Source

objects.lisp (file)

Method: title (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf title) NEW-VALUE OBJECT
Package

tooter-objects

Reader

title (generic function)

Methods
Method: (setf title) NEW-VALUE (USER-LIST user-list)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf title) NEW-VALUE (INSTANCE instance)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf title) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Return a list of trending hashtags.

See CLIENT

Package

tooter-queries

Methods
Source

queries.lisp (file)

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

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

queries.lisp (file)

Method: unblock (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

Method: unfavourite (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

Method: unfollow (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

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

queries.lisp (file)

Method: unmute (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

Method: unmute-conversation (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

Method: unpin (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

Method: unreblog (CLIENT client) (ID integer)
Source

queries.lisp (file)

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

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

Method: update-media (CLIENT client) ID &key DESCRIPTION FOCUS
Source

queries.lisp (file)

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

Method: update-user-list (CLIENT client) (ID integer) &key TITLE
Source

queries.lisp (file)

Generic Function: uri OBJECT

Returns the instance’s URI.

See INSTANCE
See STATUS

Package

tooter-objects

Writer

(setf uri) (generic function)

Methods
Method: uri (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Method: uri (INSTANCE instance)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf uri) NEW-VALUE OBJECT
Package

tooter-objects

Reader

uri (generic function)

Methods
Method: (setf uri) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf uri) NEW-VALUE (INSTANCE instance)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: url OBJECT

Returns the full URL to the object on its home instance.

See ACCOUNT
See ATTACHMENT
See CARD
See EMOJI
See INSTANCE
See MENTION
See STATUS
See TAG

Package

tooter-objects

Writer

(setf url) (generic function)

Methods
Method: url (TAG tag)

automatically generated reader method

Source

objects.lisp (file)

Method: url (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Method: url (MENTION mention)

automatically generated reader method

Source

objects.lisp (file)

Method: url (EMOJI emoji)

automatically generated reader method

Source

objects.lisp (file)

Method: url (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Method: url (ATTACHMENT attachment)

automatically generated reader method

Source

objects.lisp (file)

Method: url (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf url) NEW-VALUE OBJECT
Package

tooter-objects

Reader

url (generic function)

Methods
Method: (setf url) NEW-VALUE (TAG tag)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf url) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf url) NEW-VALUE (MENTION mention)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf url) NEW-VALUE (EMOJI emoji)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf url) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf url) NEW-VALUE (ATTACHMENT attachment)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf url) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: urls OBJECT

Returns a list of URLs for the streaming API.

See INSTANCE

Package

tooter-objects

Writer

(setf urls) (generic function)

Methods
Method: urls (INSTANCE instance)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf urls) NEW-VALUE OBJECT
Package

tooter-objects

Reader

urls (generic function)

Methods
Method: (setf urls) NEW-VALUE (INSTANCE instance)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: use-count OBJECT

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

See TAG-HISTORY

Package

tooter-objects

Writer

(setf use-count) (generic function)

Methods
Method: use-count (TAG-HISTORY tag-history)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf use-count) NEW-VALUE OBJECT
Package

tooter-objects

Reader

use-count (generic function)

Methods
Method: (setf use-count) NEW-VALUE (TAG-HISTORY tag-history)

automatically generated writer method

Source

objects.lisp (file)

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

Writer

(setf user-list-accounts) (generic function)

Methods
Method: user-list-accounts (CLIENT client) (USER-LIST user-list) &rest ARGS
Source

queries.lisp (file)

Method: user-list-accounts (CLIENT client) (ID integer) &key MAX-ID SINCE-ID LIMIT
Source

queries.lisp (file)

Generic Function: (setf user-list-accounts) ACCOUNTS CLIENT ID
Package

tooter-queries

Reader

user-list-accounts (generic function)

Methods
Method: (setf user-list-accounts) ACCOUNTS (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: user-lists CLIENT ID

Retrieve a list of up to twenty of the account’s user lists.

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

See USER-LIST
See CLIENT

Package

tooter-queries

Methods
Method: user-lists (CLIENT client) (ID (eql t))
Source

queries.lisp (file)

Method: user-lists (CLIENT client) (ACCOUNT account)
Source

queries.lisp (file)

Method: user-lists (CLIENT client) (ID integer)
Source

queries.lisp (file)

Generic Function: username OBJECT

Returns the username of the object.

The username does not include the instance/domain name.

See ACCOUNT
See MENTION

Package

tooter-objects

Writer

(setf username) (generic function)

Methods
Method: username (MENTION mention)

automatically generated reader method

Source

objects.lisp (file)

Method: username (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf username) NEW-VALUE OBJECT
Package

tooter-objects

Reader

username (generic function)

Methods
Method: (setf username) NEW-VALUE (MENTION mention)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf username) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: verify-credentials CLIENT

Returns your own account.

This updates the ACCOUNT field in the client.

See CLIENT
See ACCOUNT

Package

tooter-queries

Methods
Method: verify-credentials (CLIENT client)
Source

queries.lisp (file)

Generic Function: version OBJECT

Returns the instance’s Mastodon version.

See INSTANCE

Package

tooter-objects

Writer

(setf version) (generic function)

Methods
Method: version (INSTANCE instance)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf version) NEW-VALUE OBJECT
Package

tooter-objects

Reader

version (generic function)

Methods
Method: (setf version) NEW-VALUE (INSTANCE instance)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: visibility OBJECT

Returns the default visibility of the status.

Can be one of :PUBLIC :UNLISTED :PRIVATE :DIRECT

See STATUS

Package

tooter-objects

Writer

(setf visibility) (generic function)

Methods
Method: visibility (STATUS status)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf visibility) NEW-VALUE OBJECT
Package

tooter-objects

Reader

visibility (generic function)

Methods
Method: (setf visibility) NEW-VALUE (STATUS status)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: website OBJECT

Returns the website URL of the object.

See APPLICATION
See CLIENT

Package

tooter-objects

Writer

(setf website) (generic function)

Methods
Method: website (APPLICATION application)

automatically generated reader method

Source

objects.lisp (file)

Method: website (CLIENT client)

automatically generated reader method

Source

client.lisp (file)

Generic Function: (setf website) NEW-VALUE OBJECT
Package

tooter-objects

Reader

website (generic function)

Methods
Method: (setf website) NEW-VALUE (APPLICATION application)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf website) NEW-VALUE (CLIENT client)

automatically generated writer method

Source

client.lisp (file)

Generic Function: width OBJECT

Returns the width of the media or card.

See CARD
See IMAGE-METADATA
See VIDEO-METADATA

Package

tooter-objects

Writer

(setf width) (generic function)

Methods
Method: width (CARD card)

automatically generated reader method

Source

objects.lisp (file)

Method: width (VIDEO-METADATA video-metadata)

automatically generated reader method

Source

objects.lisp (file)

Method: width (IMAGE-METADATA image-metadata)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf width) NEW-VALUE OBJECT
Package

tooter-objects

Reader

width (generic function)

Methods
Method: (setf width) NEW-VALUE (CARD card)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf width) NEW-VALUE (VIDEO-METADATA video-metadata)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf width) NEW-VALUE (IMAGE-METADATA image-metadata)

automatically generated writer method

Source

objects.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Conditions

Condition: request-failed ()

Error signalled when a request against the Mastodon API failed.

See CODE
See DATA
See MESSAGE

Package

tooter-client

Source

client.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: code
Initargs

:code

Readers

code (generic function)

Slot: data
Initargs

:data

Readers

data (generic function)

Slot: message
Initargs

:message

Readers

message (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Classes

Class: account ()

Represents a user account on the mastodon instance.

Note that this may also be a remote account that resides on another instance.

See ID
See USERNAME
See ACCOUNT-NAME
See DISPLAY-NAME
See LOCKED
See CREATED-AT
See FOLLOWERS-COUNT
See FOLLOWING-COUNT
See STATUSES-COUNT
See NOTE
See URL
See AVATAR
See AVATAR-STATIC
See HEADER
See HEADER-STATIC
See MOVED
See FIELDS
See BOT
See SOURCE

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(error #a((26) base-char . "id required for a account."))

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: username
Initargs

:username

Initform

(error #a((32) base-char . "username required for a account."))

Readers

username (generic function)

Writers

(setf username) (generic function)

Slot: account-name
Initargs

:account-name

Initform

(error #a((36) base-char . "account-name required for a account."))

Readers

account-name (generic function)

Writers

(setf account-name) (generic function)

Slot: display-name
Initargs

:display-name

Initform

(error #a((36) base-char . "display-name required for a account."))

Readers

display-name (generic function)

Writers

(setf display-name) (generic function)

Slot: locked
Initargs

:locked

Initform

(error #a((30) base-char . "locked required for a account."))

Readers

locked (generic function)

Writers

(setf locked) (generic function)

Slot: created-at
Initargs

:created-at

Initform

(error #a((34) base-char . "created-at required for a account."))

Readers

created-at (generic function)

Writers

(setf created-at) (generic function)

Slot: followers-count
Initargs

:followers-count

Initform

(error #a((39) base-char . "followers-count required for a account."))

Readers

followers-count (generic function)

Writers

(setf followers-count) (generic function)

Slot: following-count
Initargs

:following-count

Initform

(error #a((39) base-char . "following-count required for a account."))

Readers

following-count (generic function)

Writers

(setf following-count) (generic function)

Slot: statuses-count
Initargs

:statuses-count

Initform

(error #a((38) base-char . "statuses-count required for a account."))

Readers

statuses-count (generic function)

Writers

(setf statuses-count) (generic function)

Slot: note
Initargs

:note

Initform

(error #a((28) base-char . "note required for a account."))

Readers

note (generic function)

Writers

(setf note) (generic function)

Slot: url
Initargs

:url

Initform

(error #a((27) base-char . "url required for a account."))

Readers

url (generic function)

Writers

(setf url) (generic function)

Slot: avatar
Initargs

:avatar

Initform

(error #a((30) base-char . "avatar required for a account."))

Readers

avatar (generic function)

Writers

(setf avatar) (generic function)

Slot: avatar-static
Initargs

:avatar-static

Initform

(error #a((37) base-char . "avatar-static required for a account."))

Readers

avatar-static (generic function)

Writers

(setf avatar-static) (generic function)

Slot: header
Initargs

:header

Initform

(error #a((30) base-char . "header required for a account."))

Readers

header (generic function)

Writers

(setf header) (generic function)

Slot: header-static
Initargs

:header-static

Initform

(error #a((37) base-char . "header-static required for a account."))

Readers

header-static (generic function)

Writers

(setf header-static) (generic function)

Slot: moved
Initargs

:moved

Readers

moved (generic function)

Writers

(setf moved) (generic function)

Slot: fields
Initargs

:fields

Readers

fields (generic function)

Writers

(setf fields) (generic function)

Slot: bot
Initargs

:bot

Readers

bot (generic function)

Writers

(setf bot) (generic function)

Slot: source
Initargs

:source

Readers

source (generic function)

Writers

(setf source) (generic function)

Class: application ()

Representation of an application as registered on a Mastodon instance.

See NAME
See WEBSITE

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Initform

(error #a((32) base-char . "name required for a application."))

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: website
Initargs

:website

Readers

website (generic function)

Writers

(setf website) (generic function)

Class: attachment ()

Representation of a media attachment for a status.

See ID
See KIND
See URL
See REMOTE-URL
See PREVIEW-URL
See TEXT-URL
See METADATA
See DESCRIPTION

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(error #a((29) base-char . "id required for a attachment."))

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: kind
Initargs

:kind

Initform

(error #a((31) base-char . "kind required for a attachment."))

Readers

kind (generic function)

Writers

(setf kind) (generic function)

Slot: url
Initargs

:url

Initform

(error #a((30) base-char . "url required for a attachment."))

Readers

url (generic function)

Writers

(setf url) (generic function)

Slot: remote-url
Initargs

:remote-url

Readers

remote-url (generic function)

Writers

(setf remote-url) (generic function)

Slot: preview-url
Initargs

:preview-url

Initform

(error #a((38) base-char . "preview-url required for a attachment."))

Readers

preview-url (generic function)

Writers

(setf preview-url) (generic function)

Slot: text-url
Initargs

:text-url

Readers

text-url (generic function)

Writers

(setf text-url) (generic function)

Slot: metadata
Initargs

:metadata

Readers

metadata (generic function)

Writers

(setf metadata) (generic function)

Slot: description
Initargs

:description

Readers

description (generic function)

Writers

(setf description) (generic function)

Class: card ()

Cards represent all information to summarise a status.

See URL
See TITLE
See DESCRIPTION
See IMAGE
See KIND
See AUTHOR-NAME
See AUTHOR-URL
See PROVIDER-NAME
See PROVIDER-URL
See HTML
See WIDTH
See HEIGHT

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: url
Initargs

:url

Initform

(error #a((24) base-char . "url required for a card."))

Readers

url (generic function)

Writers

(setf url) (generic function)

Slot: title
Initargs

:title

Initform

(error #a((26) base-char . "title required for a card."))

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: description
Initargs

:description

Initform

(error #a((32) base-char . "description required for a card."))

Readers

description (generic function)

Writers

(setf description) (generic function)

Slot: image
Initargs

:image

Readers

image (generic function)

Writers

(setf image) (generic function)

Slot: kind
Initargs

:kind

Initform

(error #a((25) base-char . "kind required for a card."))

Readers

kind (generic function)

Writers

(setf kind) (generic function)

Slot: author-name
Initargs

:author-name

Readers

author-name (generic function)

Writers

(setf author-name) (generic function)

Slot: author-url
Initargs

:author-url

Readers

author-url (generic function)

Writers

(setf author-url) (generic function)

Slot: provider-name
Initargs

:provider-name

Readers

provider-name (generic function)

Writers

(setf provider-name) (generic function)

Slot: provider-url
Initargs

:provider-url

Readers

provider-url (generic function)

Writers

(setf provider-url) (generic function)

Slot: html
Initargs

:html

Readers

html (generic function)

Writers

(setf html) (generic function)

Slot: width
Initargs

:width

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: height
Initargs

:height

Readers

height (generic function)

Writers

(setf height) (generic function)

Class: client ()

Representation of an application client connecting to a Mastodon instance.

If you are creating a library providing some kind of service based on Mastodon, you should create a wrapper function that fills in the fields like NAME, REDIRECT, SCOPES, and WEBSITE, but lets the user specify the BASE so that it can be used against any Mastodon instance.

The fields KEY, SECRET, and ACCESS-TOKEN are specific to your application, Mastodon instance, and the user using the application. You should save these fields away somewhere after they’ve been initialised so that they can be re-used at a later point without having to re- register and re-authorise.

The KEY and SECRET will be filled in by REGISTER. The ACCESS-TOKEN will be filled in by AUTHORIZE once the user calls it with a valid AUTHORIZATION-CODE retrieved by authorizing the application.

Generally the procedure for using a client is as follows: fill in the BASE and NAME, call AUTHORIZE and instruct the user to follow the URL from the second return value. Make the user call AUTHORIZE again with the code from the website as the second argument. Once that’s done, you should be fine to make any calls necessary from there on out. Make sure to persist the KEY, SECRET, and ACCESS-TOKEN for future use. ACCESS-TOKENs should not expire unless the user revokes access manually.

CLIENT instances can be dumped to FASLs.

See BASE
See KEY
See SECRET
See ACCESS-TOKEN
See NAME
See REDIRECT
See SCOPES
See WEBSITE
See ACCOUNT
See REGISTER
See AUTHORIZE
See DEFAULT-HEADERS
See QUERY
See SUBMIT

Package

tooter-client

Source

client.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: base
Initargs

:base

Readers

base (generic function)

Writers

(setf base) (generic function)

Slot: key
Initargs

:key

Readers

key (generic function)

Writers

(setf key) (generic function)

Slot: secret
Initargs

:secret

Readers

secret (generic function)

Writers

(setf secret) (generic function)

Slot: access-token
Initargs

:access-token

Readers

access-token (generic function)

Writers

(setf access-token) (generic function)

Slot: name
Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: redirect
Initargs

:redirect

Readers

redirect (generic function)

Writers

(setf redirect) (generic function)

Slot: scopes
Initargs

:scopes

Readers

scopes (generic function)

Writers

(setf scopes) (generic function)

Slot: website
Initargs

:website

Readers

website (generic function)

Writers

(setf website) (generic function)

Slot: account
Readers

account (generic function)

Writers

(setf account) (generic function)

Direct Default Initargs
InitargValue
:base(error "base required.")
:keynil
:secretnil
:access-tokennil
:name(error "name required.")
:redirect"urn:ietf:wg:oauth:2.0:oob"
:scopes(quote (:read :write :follow))
:websitenil
Class: context ()

An object representing a status’ context.

Contexts are used to represent reply chains.

See ANCESTORS
See DESCENDANTS

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: ancestors
Initargs

:ancestors

Initform

(error #a((33) base-char . "ancestors required for a context."))

Readers

ancestors (generic function)

Writers

(setf ancestors) (generic function)

Slot: descendants
Initargs

:descendants

Initform

(error #a((35) base-char . "descendants required for a context."))

Readers

descendants (generic function)

Writers

(setf descendants) (generic function)

Class: emoji ()

Representation of a custom emoticon on the instance.

See SHORTCODE
See STATIC-URL
See URL

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: shortcode
Initargs

:shortcode

Initform

(error #a((31) base-char . "shortcode required for a emoji."))

Readers

shortcode (generic function)

Writers

(setf shortcode) (generic function)

Slot: static-url
Initargs

:static-url

Initform

(error #a((32) base-char . "static-url required for a emoji."))

Readers

static-url (generic function)

Writers

(setf static-url) (generic function)

Slot: url
Initargs

:url

Initform

(error #a((25) base-char . "url required for a emoji."))

Readers

url (generic function)

Writers

(setf url) (generic function)

Class: entity ()

Superclass for all objects returned by Mastodon API queries.

See DECODE-ENTITY

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Class: image-metadata ()

Metadata for static images.

See WIDTH
See HEIGHT
See SIZE
See ASPECT

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: width
Initargs

:width

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: height
Initargs

:height

Readers

height (generic function)

Writers

(setf height) (generic function)

Slot: size
Initargs

:size

Readers

size (generic function)

Writers

(setf size) (generic function)

Slot: aspect
Initargs

:aspect

Readers

aspect (generic function)

Writers

(setf aspect) (generic function)

Class: instance ()

Representation of a Mastodon server instance.

See URI
See TITLE
See DESCRIPTION
See EMAIL
See VERSION
See URLS
See LANGUAGES
See CONTACT-ACCOUNT

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Initform

(error #a((28) base-char . "uri required for a instance."))

Readers

uri (generic function)

Writers

(setf uri) (generic function)

Slot: title
Initargs

:title

Initform

(error #a((30) base-char . "title required for a instance."))

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: description
Initargs

:description

Initform

(error #a((36) base-char . "description required for a instance."))

Readers

description (generic function)

Writers

(setf description) (generic function)

Slot: email
Initargs

:email

Initform

(error #a((30) base-char . "email required for a instance."))

Readers

email (generic function)

Writers

(setf email) (generic function)

Slot: version
Initargs

:version

Initform

(error #a((32) base-char . "version required for a instance."))

Readers

version (generic function)

Writers

(setf version) (generic function)

Slot: urls
Initargs

:urls

Initform

(error #a((29) base-char . "urls required for a instance."))

Readers

urls (generic function)

Writers

(setf urls) (generic function)

Slot: languages
Initargs

:languages

Initform

(error #a((34) base-char . "languages required for a instance."))

Readers

languages (generic function)

Writers

(setf languages) (generic function)

Slot: contact-account
Initargs

:contact-account

Initform

(error #a((40) base-char . "contact-account required for a instance."))

Readers

contact-account (generic function)

Writers

(setf contact-account) (generic function)

Class: mention ()

Representation of an account mention in a status.

See URL
See USERNAME
See ACCOUNT-NAME
See ID

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: url
Initargs

:url

Initform

(error #a((27) base-char . "url required for a mention."))

Readers

url (generic function)

Writers

(setf url) (generic function)

Slot: username
Initargs

:username

Initform

(error #a((32) base-char . "username required for a mention."))

Readers

username (generic function)

Writers

(setf username) (generic function)

Slot: account-name
Initargs

:account-name

Initform

(error #a((36) base-char . "account-name required for a mention."))

Readers

account-name (generic function)

Writers

(setf account-name) (generic function)

Slot: id
Initargs

:id

Initform

(error #a((26) base-char . "id required for a mention."))

Readers

id (generic function)

Writers

(setf id) (generic function)

Class: metadata ()

This object holds metadata information for media objects.

See SMALL
See ORIGINAL
See FOCUS

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: small
Initargs

:small

Readers

small (generic function)

Writers

(setf small) (generic function)

Slot: original
Initargs

:original

Readers

original (generic function)

Writers

(setf original) (generic function)

Slot: focus
Initargs

:focus

Readers

focus (generic function)

Writers

(setf focus) (generic function)

Class: notification ()

Representation of a new status update notification.

See ID
See KIND
See CREATED-AT
See ACCOUNT
See STATUS

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(error #a((31) base-char . "id required for a notification."))

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: kind
Initargs

:kind

Initform

(error #a((33) base-char . "kind required for a notification."))

Readers

kind (generic function)

Writers

(setf kind) (generic function)

Slot: created-at
Initargs

:created-at

Initform

(error #a((39) base-char . "created-at required for a notification."))

Readers

created-at (generic function)

Writers

(setf created-at) (generic function)

Slot: account
Initargs

:account

Initform

(error #a((36) base-char . "account required for a notification."))

Readers

account (generic function)

Writers

(setf account) (generic function)

Slot: status
Initargs

:status

Readers

status (generic function)

Writers

(setf status) (generic function)

Class: push-subscription ()

Representation of a push notification subscription.

See ID
See ENDPOINT
See SERVER-KEY
See ALERTS

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(error #a((36) base-char . "id required for a push-subscription."))

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: endpoint
Initargs

:endpoint

Initform

(error #a((42) base-char . "endpoint required for a push-subscription."))

Readers

endpoint (generic function)

Writers

(setf endpoint) (generic function)

Slot: server-key
Initargs

:server-key

Initform

(error #a((44) base-char . "server-key required for a push-subscription."))

Readers

server-key (generic function)

Writers

(setf server-key) (generic function)

Slot: alerts
Initargs

:alerts

Readers

alerts (generic function)

Writers

(setf alerts) (generic function)

Class: relationship ()

Representation of a relationship between the current user and another account.

See ID
See FOLLOWING
See FOLLOWED-BY
See BLOCKING
See MUTING
See MUTING-NOTIFICATIONS
See REQUESTED
See DOMAIN-BLOCKING

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(error #a((31) base-char . "id required for a relationship."))

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: following
Initargs

:following

Initform

(error #a((38) base-char . "following required for a relationship."))

Readers

following (generic function)

Writers

(setf following) (generic function)

Slot: followed-by
Initargs

:followed-by

Initform

(error #a((40) base-char . "followed-by required for a relationship."))

Readers

followed-by (generic function)

Writers

(setf followed-by) (generic function)

Slot: blocking
Initargs

:blocking

Initform

(error #a((37) base-char . "blocking required for a relationship."))

Readers

blocking (generic function)

Writers

(setf blocking) (generic function)

Slot: muting
Initargs

:muting

Initform

(error #a((35) base-char . "muting required for a relationship."))

Readers

muting (generic function)

Writers

(setf muting) (generic function)

Slot: muting-notifications
Initargs

:muting-notifications

Initform

(error #a((49) base-char . "muting-notifications required for a relationship."))

Readers

muting-notifications (generic function)

Writers

(setf muting-notifications) (generic function)

Slot: requested
Initargs

:requested

Initform

(error #a((38) base-char . "requested required for a relationship."))

Readers

requested (generic function)

Writers

(setf requested) (generic function)

Slot: domain-blocking
Initargs

:domain-blocking

Initform

(error #a((44) base-char . "domain-blocking required for a relationship."))

Readers

domain-blocking (generic function)

Writers

(setf domain-blocking) (generic function)

Class: report ()

Representation of an incident report.

See ID
See ACTION-TAKEN

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(error #a((25) base-char . "id required for a report."))

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: action-taken
Initargs

:action-taken

Initform

(error #a((35) base-char . "action-taken required for a report."))

Readers

action-taken (generic function)

Writers

(setf action-taken) (generic function)

Class: results ()

Representation of a search result.

See ACCOUNTS
See STATUSES
See HASHTAGS

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: accounts
Initargs

:accounts

Initform

(error #a((32) base-char . "accounts required for a results."))

Readers

accounts (generic function)

Writers

(setf accounts) (generic function)

Slot: statuses
Initargs

:statuses

Initform

(error #a((32) base-char . "statuses required for a results."))

Readers

statuses (generic function)

Writers

(setf statuses) (generic function)

Slot: hashtags
Initargs

:hashtags

Initform

(error #a((32) base-char . "hashtags required for a results."))

Readers

hashtags (generic function)

Writers

(setf hashtags) (generic function)

Class: status ()

Representation of a status update.

"Statuses", "toots", or "tweets" are the primary content of a Mastodon instance.

See ID
See URI
See URL
See ACCOUNT
See IN-REPLY-TO-ID
See IN-REPLY-TO-ACCOUNT-ID
See PARENT
See CONTENT
See CREATED-AT
See EMOJIS
See REBLOGS-COUNT
See FAVOURITES-COUNT
See REBLOGGED
See FAVOURITED
See MUTED
See SENSITIVE
See SPOILER-TEXT
See VISIBILITY
See MEDIA-ATTACHMENTS
See MENTIONS
See TAGS
See APPLICATION
See LANGUAGE
See PINNED

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(error #a((25) base-char . "id required for a status."))

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: uri
Initargs

:uri

Initform

(error #a((26) base-char . "uri required for a status."))

Readers

uri (generic function)

Writers

(setf uri) (generic function)

Slot: url
Initargs

:url

Readers

url (generic function)

Writers

(setf url) (generic function)

Slot: account
Initargs

:account

Initform

(error #a((30) base-char . "account required for a status."))

Readers

account (generic function)

Writers

(setf account) (generic function)

Slot: in-reply-to-id
Initargs

:in-reply-to-id

Readers

in-reply-to-id (generic function)

Writers

(setf in-reply-to-id) (generic function)

Slot: in-reply-to-account-id
Initargs

:in-reply-to-account-id

Readers

in-reply-to-account-id (generic function)

Writers

(setf in-reply-to-account-id) (generic function)

Slot: parent
Initargs

:parent

Readers

parent (generic function)

Writers

(setf parent) (generic function)

Slot: content
Initargs

:content

Initform

(error #a((30) base-char . "content required for a status."))

Readers

content (generic function)

Writers

(setf content) (generic function)

Slot: created-at
Initargs

:created-at

Initform

(error #a((33) base-char . "created-at required for a status."))

Readers

created-at (generic function)

Writers

(setf created-at) (generic function)

Slot: emojis
Initargs

:emojis

Initform

(error #a((29) base-char . "emojis required for a status."))

Readers

emojis (generic function)

Writers

(setf emojis) (generic function)

Slot: reblogs-count
Initargs

:reblogs-count

Initform

(error #a((36) base-char . "reblogs-count required for a status."))

Readers

reblogs-count (generic function)

Writers

(setf reblogs-count) (generic function)

Slot: favourites-count
Initargs

:favourites-count

Initform

(error #a((39) base-char . "favourites-count required for a status."))

Readers

favourites-count (generic function)

Writers

(setf favourites-count) (generic function)

Slot: reblogged
Initargs

:reblogged

Readers

reblogged (generic function)

Writers

(setf reblogged) (generic function)

Slot: favourited
Initargs

:favourited

Readers

favourited (generic function)

Writers

(setf favourited) (generic function)

Slot: muted
Initargs

:muted

Readers

muted (generic function)

Writers

(setf muted) (generic function)

Slot: sensitive
Initargs

:sensitive

Initform

(error #a((32) base-char . "sensitive required for a status."))

Readers

sensitive (generic function)

Writers

(setf sensitive) (generic function)

Slot: spoiler-text
Initargs

:spoiler-text

Initform

(error #a((35) base-char . "spoiler-text required for a status."))

Readers

spoiler-text (generic function)

Writers

(setf spoiler-text) (generic function)

Slot: visibility
Initargs

:visibility

Initform

(error #a((33) base-char . "visibility required for a status."))

Readers

visibility (generic function)

Writers

(setf visibility) (generic function)

Slot: media-attachments
Initargs

:media-attachments

Initform

(error #a((40) base-char . "media-attachments required for a status."))

Readers

media-attachments (generic function)

Writers

(setf media-attachments) (generic function)

Slot: mentions
Initargs

:mentions

Initform

(error #a((31) base-char . "mentions required for a status."))

Readers

mentions (generic function)

Writers

(setf mentions) (generic function)

Slot: tags
Initargs

:tags

Initform

(error #a((27) base-char . "tags required for a status."))

Readers

tags (generic function)

Writers

(setf tags) (generic function)

Slot: application
Initargs

:application

Readers

application (generic function)

Writers

(setf application) (generic function)

Slot: language
Initargs

:language

Readers

language (generic function)

Writers

(setf language) (generic function)

Slot: pinned
Initargs

:pinned

Readers

pinned (generic function)

Writers

(setf pinned) (generic function)

Class: tag ()

Representation of a hashtag used in a status.

See NAME
See URL
See HISTORY

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Initform

(error #a((24) base-char . "name required for a tag."))

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: url
Initargs

:url

Initform

(error #a((23) base-char . "url required for a tag."))

Readers

url (generic function)

Writers

(setf url) (generic function)

Slot: history
Initargs

:history

Readers

history (generic function)

Writers

(setf history) (generic function)

Class: tag-history ()

Representation of the usage history of a hashtag.

See DAY
See USE-COUNT
See ACCOUNT-COUNT

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: day
Initargs

:day

Initform

(error #a((31) base-char . "day required for a tag-history."))

Readers

day (generic function)

Writers

(setf day) (generic function)

Slot: use-count
Initargs

:use-count

Initform

(error #a((37) base-char . "use-count required for a tag-history."))

Readers

use-count (generic function)

Writers

(setf use-count) (generic function)

Slot: account-count
Initargs

:account-count

Initform

(error #a((41) base-char . "account-count required for a tag-history."))

Readers

account-count (generic function)

Writers

(setf account-count) (generic function)

Class: user-list ()

Represents a list of users.

See ID
See TITLE

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(error #a((28) base-char . "id required for a user-list."))

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: title
Initargs

:title

Initform

(error #a((31) base-char . "title required for a user-list."))

Readers

title (generic function)

Writers

(setf title) (generic function)

Class: video-metadata ()

Metadata for animated videos.

See WIDTH
See HEIGHT
See FRAME-RATE
See DURATION
See BITRATE

Package

tooter-objects

Source

objects.lisp (file)

Direct superclasses

entity (class)

Direct methods
Direct slots
Slot: width
Initargs

:width

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: height
Initargs

:height

Readers

height (generic function)

Writers

(setf height) (generic function)

Slot: frame-rate
Initargs

:frame-rate

Readers

frame-rate (generic function)

Writers

(setf frame-rate) (generic function)

Slot: duration
Initargs

:duration

Readers

duration (generic function)

Writers

(setf duration) (generic function)

Slot: bitrate
Initargs

:bitrate

Readers

bitrate (generic function)

Writers

(setf bitrate) (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *html-escape-table*
Package

tooter

Source

toolkit.lisp (file)

Special Variable: *translator*
Package

tooter

Source

objects.lisp (file)

Special Variable: *unix-epoch-difference*
Package

tooter

Source

toolkit.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: define-entity NAME &body SLOTS
Package

tooter

Source

objects.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Compiler macros

Compiler Macro: getj DATA &rest ATTRIBUTES
Package

tooter

Source

toolkit.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: %decode-metadata DATA
Package

tooter

Source

objects.lisp (file)

Function: %getj DATA &rest ATTRIBUTES
Package

tooter

Source

toolkit.lisp (file)

Function: %request URI PARAMETERS HEADERS METHOD CONTENT-TYPE
Package

tooter

Source

client.lisp (file)

Function: %timeline CLIENT URL &key LOCAL ONLY-MEDIA MAX-ID SINCE-ID LIMIT
Package

tooter

Source

queries.lisp (file)

Function: coerce-boolean BOOLEAN PROVIDED
Package

tooter

Source

toolkit.lisp (file)

Function: convert-fields FIELDS
Package

tooter

Source

objects.lisp (file)

Function: convert-timestamp STAMP
Package

tooter

Source

toolkit.lisp (file)

Function: decode-account DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-application DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-attachment DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-card DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-context DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-emoji DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-image-metadata DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-instance DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-mention DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-metadata DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-notification DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-push-subscription DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-relationship DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-report DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-results DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-status DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-tag DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-tag-history DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-user-list DATA0
Package

tooter

Source

objects.lisp (file)

Function: decode-video-metadata DATA0
Package

tooter

Source

objects.lisp (file)

Function: getj DATA &rest ATTRIBUTES
Package

tooter

Source

toolkit.lisp (file)

Function: line-wrap STRING &key WIDTH PREFIX
Package

tooter

Source

toolkit.lisp (file)

Function: make-url BASE &rest PARAMETERS
Package

tooter

Source

toolkit.lisp (file)

Function: param-plist->alist PLIST
Package

tooter

Source

toolkit.lisp (file)

Function: parse-timestring STRING
Package

tooter

Source

toolkit.lisp (file)

Function: to-keyword A
Package

tooter

Source

toolkit.lisp (file)

Function: translate-key KEY
Package

tooter

Source

toolkit.lisp (file)

Function: translate-languages LANGUAGES
Package

tooter

Source

objects.lisp (file)

Function: universal->unix UNIVERSAL
Package

tooter

Source

toolkit.lisp (file)

Function: unix->universal UNIX
Package

tooter

Source

toolkit.lisp (file)

Function: url-encode THING &optional EXTERNAL-FORMAT
Package

tooter

Source

toolkit.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Generic functions

Generic Function: 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

Writer

(setf account-name) (generic function)

Methods
Method: account-name (MENTION mention)

automatically generated reader method

Source

objects.lisp (file)

Method: account-name (ACCOUNT account)

automatically generated reader method

Source

objects.lisp (file)

Generic Function: (setf account-name) NEW-VALUE OBJECT
Package

tooter

Reader

account-name (generic function)

Methods
Method: (setf account-name) NEW-VALUE (MENTION mention)

automatically generated writer method

Source

objects.lisp (file)

Method: (setf account-name) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

objects.lisp (file)

Generic Function: present STATUS STREAM
Package

tooter

Methods
Method: present (STATUS status) (STREAM stream)
Source

objects.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   T  
Index Entry  Section

F
File, Lisp, tooter.asd: The tooter<dot>asd file
File, Lisp, tooter/client.lisp: The tooter/client<dot>lisp file
File, Lisp, tooter/documentation.lisp: The tooter/documentation<dot>lisp file
File, Lisp, tooter/objects.lisp: The tooter/objects<dot>lisp file
File, Lisp, tooter/package.lisp: The tooter/package<dot>lisp file
File, Lisp, tooter/queries.lisp: The tooter/queries<dot>lisp file
File, Lisp, tooter/toolkit.lisp: The tooter/toolkit<dot>lisp file

L
Lisp File, tooter.asd: The tooter<dot>asd file
Lisp File, tooter/client.lisp: The tooter/client<dot>lisp file
Lisp File, tooter/documentation.lisp: The tooter/documentation<dot>lisp file
Lisp File, tooter/objects.lisp: The tooter/objects<dot>lisp file
Lisp File, tooter/package.lisp: The tooter/package<dot>lisp file
Lisp File, tooter/queries.lisp: The tooter/queries<dot>lisp file
Lisp File, tooter/toolkit.lisp: The tooter/toolkit<dot>lisp file

T
tooter.asd: The tooter<dot>asd file
tooter/client.lisp: The tooter/client<dot>lisp file
tooter/documentation.lisp: The tooter/documentation<dot>lisp file
tooter/objects.lisp: The tooter/objects<dot>lisp file
tooter/package.lisp: The tooter/package<dot>lisp file
tooter/queries.lisp: The tooter/queries<dot>lisp file
tooter/toolkit.lisp: The tooter/toolkit<dot>lisp file

Jump to:   F   L   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   K   L   M   N   O   P   Q   R   S   T   U   V   W  
Index Entry  Section

%
%decode-metadata: Internal functions
%getj: Internal functions
%request: Internal functions
%timeline: Internal functions

(
(setf access-token): Exported generic functions
(setf access-token): Exported generic functions
(setf account): Exported generic functions
(setf account): Exported generic functions
(setf account): Exported generic functions
(setf account): Exported generic functions
(setf account-count): Exported generic functions
(setf account-count): Exported generic functions
(setf account-name): Internal generic functions
(setf account-name): Internal generic functions
(setf account-name): Internal generic functions
(setf accounts): Exported generic functions
(setf accounts): Exported generic functions
(setf action-taken): Exported generic functions
(setf action-taken): Exported generic functions
(setf alerts): Exported generic functions
(setf alerts): Exported generic functions
(setf ancestors): Exported generic functions
(setf ancestors): Exported generic functions
(setf application): Exported generic functions
(setf application): Exported generic functions
(setf aspect): Exported generic functions
(setf aspect): Exported generic functions
(setf author-name): Exported generic functions
(setf author-name): Exported generic functions
(setf author-url): Exported generic functions
(setf author-url): Exported generic functions
(setf avatar): Exported generic functions
(setf avatar): Exported generic functions
(setf avatar-static): Exported generic functions
(setf avatar-static): Exported generic functions
(setf base): Exported generic functions
(setf base): Exported generic functions
(setf bitrate): Exported generic functions
(setf bitrate): Exported generic functions
(setf blocking): Exported generic functions
(setf blocking): Exported generic functions
(setf bot): Exported generic functions
(setf bot): Exported generic functions
(setf contact-account): Exported generic functions
(setf contact-account): Exported generic functions
(setf content): Exported generic functions
(setf content): Exported generic functions
(setf created-at): Exported generic functions
(setf created-at): Exported generic functions
(setf created-at): Exported generic functions
(setf created-at): Exported generic functions
(setf day): Exported generic functions
(setf day): Exported generic functions
(setf descendants): Exported generic functions
(setf descendants): Exported generic functions
(setf description): Exported generic functions
(setf description): Exported generic functions
(setf description): Exported generic functions
(setf description): Exported generic functions
(setf display-name): Exported generic functions
(setf display-name): Exported generic functions
(setf domain-blocking): Exported generic functions
(setf domain-blocking): Exported generic functions
(setf duration): Exported generic functions
(setf duration): Exported generic functions
(setf email): Exported generic functions
(setf email): Exported generic functions
(setf emojis): Exported generic functions
(setf emojis): Exported generic functions
(setf endpoint): Exported generic functions
(setf endpoint): Exported generic functions
(setf favourited): Exported generic functions
(setf favourited): Exported generic functions
(setf favourites-count): Exported generic functions
(setf favourites-count): Exported generic functions
(setf fields): Exported generic functions
(setf fields): Exported generic functions
(setf focus): Exported generic functions
(setf focus): Exported generic functions
(setf followed-by): Exported generic functions
(setf followed-by): Exported generic functions
(setf followers-count): Exported generic functions
(setf followers-count): Exported generic functions
(setf following): Exported generic functions
(setf following): Exported generic functions
(setf following-count): Exported generic functions
(setf following-count): Exported generic functions
(setf frame-rate): Exported generic functions
(setf frame-rate): Exported generic functions
(setf hashtags): Exported generic functions
(setf hashtags): Exported generic functions
(setf header): Exported generic functions
(setf header): Exported generic functions
(setf header-static): Exported generic functions
(setf header-static): Exported generic functions
(setf height): Exported generic functions
(setf height): Exported generic functions
(setf height): Exported generic functions
(setf height): Exported generic functions
(setf history): Exported generic functions
(setf history): Exported generic functions
(setf html): Exported generic functions
(setf html): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf image): Exported generic functions
(setf image): Exported generic functions
(setf in-reply-to-account-id): Exported generic functions
(setf in-reply-to-account-id): Exported generic functions
(setf in-reply-to-id): Exported generic functions
(setf in-reply-to-id): Exported generic functions
(setf key): Exported generic functions
(setf key): Exported generic functions
(setf kind): Exported generic functions
(setf kind): Exported generic functions
(setf kind): Exported generic functions
(setf kind): Exported generic functions
(setf language): Exported generic functions
(setf language): Exported generic functions
(setf languages): Exported generic functions
(setf languages): Exported generic functions
(setf locked): Exported generic functions
(setf locked): Exported generic functions
(setf media-attachments): Exported generic functions
(setf media-attachments): Exported generic functions
(setf mentions): Exported generic functions
(setf mentions): Exported generic functions
(setf metadata): Exported generic functions
(setf metadata): Exported generic functions
(setf moved): Exported generic functions
(setf moved): Exported generic functions
(setf muted): Exported generic functions
(setf muted): Exported generic functions
(setf muting): Exported generic functions
(setf muting): Exported generic functions
(setf muting-notifications): Exported generic functions
(setf muting-notifications): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf note): Exported generic functions
(setf note): Exported generic functions
(setf original): Exported generic functions
(setf original): Exported generic functions
(setf parent): Exported generic functions
(setf parent): Exported generic functions
(setf pinned): Exported generic functions
(setf pinned): Exported generic functions
(setf preview-url): Exported generic functions
(setf preview-url): Exported generic functions
(setf provider-name): Exported generic functions
(setf provider-name): Exported generic functions
(setf provider-url): Exported generic functions
(setf provider-url): Exported generic functions
(setf reblogged): Exported generic functions
(setf reblogged): Exported generic functions
(setf reblogs-count): Exported generic functions
(setf reblogs-count): Exported generic functions
(setf redirect): Exported generic functions
(setf redirect): Exported generic functions
(setf remote-url): Exported generic functions
(setf remote-url): Exported generic functions
(setf requested): Exported generic functions
(setf requested): Exported generic functions
(setf scopes): Exported generic functions
(setf scopes): Exported generic functions
(setf secret): Exported generic functions
(setf secret): Exported generic functions
(setf sensitive): Exported generic functions
(setf sensitive): Exported generic functions
(setf server-key): Exported generic functions
(setf server-key): Exported generic functions
(setf shortcode): Exported generic functions
(setf shortcode): Exported generic functions
(setf size): Exported generic functions
(setf size): Exported generic functions
(setf small): Exported generic functions
(setf small): Exported generic functions
(setf source): Exported generic functions
(setf source): Exported generic functions
(setf spoiler-text): Exported generic functions
(setf spoiler-text): Exported generic functions
(setf static-url): Exported generic functions
(setf static-url): Exported generic functions
(setf status): Exported generic functions
(setf status): Exported generic functions
(setf statuses): Exported generic functions
(setf statuses): Exported generic functions
(setf statuses-count): Exported generic functions
(setf statuses-count): Exported generic functions
(setf tags): Exported generic functions
(setf tags): Exported generic functions
(setf text-url): Exported generic functions
(setf text-url): Exported generic functions
(setf title): Exported generic functions
(setf title): Exported generic functions
(setf title): Exported generic functions
(setf title): Exported generic functions
(setf uri): Exported generic functions
(setf uri): Exported generic functions
(setf uri): Exported generic functions
(setf url): Exported generic functions
(setf url): Exported generic functions
(setf url): Exported generic functions
(setf url): Exported generic functions
(setf url): Exported generic functions
(setf url): Exported generic functions
(setf url): Exported generic functions
(setf url): Exported generic functions
(setf urls): Exported generic functions
(setf urls): Exported generic functions
(setf use-count): Exported generic functions
(setf use-count): Exported generic functions
(setf user-list-accounts): Exported generic functions
(setf user-list-accounts): Exported generic functions
(setf username): Exported generic functions
(setf username): Exported generic functions
(setf username): Exported generic functions
(setf version): Exported generic functions
(setf version): Exported generic functions
(setf visibility): Exported generic functions
(setf visibility): Exported generic functions
(setf website): Exported generic functions
(setf website): Exported generic functions
(setf website): Exported generic functions
(setf width): Exported generic functions
(setf width): Exported generic functions
(setf width): Exported generic functions
(setf width): Exported generic functions

A
accept-request: Exported generic functions
accept-request: Exported generic functions
accept-request: Exported generic functions
access-token: Exported generic functions
access-token: Exported generic functions
account: Exported generic functions
account: Exported generic functions
account: Exported generic functions
account: Exported generic functions
account-count: Exported generic functions
account-count: Exported generic functions
account-name: Internal generic functions
account-name: Internal generic functions
account-name: Internal generic functions
accounts: Exported generic functions
accounts: Exported generic functions
action-taken: Exported generic functions
action-taken: Exported generic functions
add-user-list-accounts: Exported generic functions
add-user-list-accounts: Exported generic functions
add-user-list-accounts: Exported generic functions
alerts: Exported generic functions
alerts: Exported generic functions
ancestors: Exported generic functions
ancestors: Exported generic functions
application: Exported generic functions
application: Exported generic functions
aspect: Exported generic functions
aspect: Exported generic functions
author-name: Exported generic functions
author-name: Exported generic functions
author-url: Exported generic functions
author-url: Exported generic functions
authorize: Exported generic functions
authorize: Exported generic functions
avatar: Exported generic functions
avatar: Exported generic functions
avatar-static: Exported generic functions
avatar-static: Exported generic functions

B
base: Exported generic functions
base: Exported generic functions
bitrate: Exported generic functions
bitrate: Exported generic functions
block: Exported generic functions
block: Exported generic functions
block: Exported generic functions
block: Exported generic functions
blocked-domains: Exported generic functions
blocked-domains: Exported generic functions
blocking: Exported generic functions
blocking: Exported generic functions
blocks: Exported generic functions
blocks: Exported generic functions
bot: Exported generic functions
bot: Exported generic functions

C
card: Exported generic functions
card: Exported generic functions
card: Exported generic functions
code: Exported generic functions
code: Exported generic functions
coerce-boolean: Internal functions
Compiler Macro, getj: Internal compiler macros
contact-account: Exported generic functions
contact-account: Exported generic functions
content: Exported generic functions
content: Exported generic functions
context: Exported generic functions
context: Exported generic functions
context: Exported generic functions
convert-fields: Internal functions
convert-timestamp: Internal functions
created-at: Exported generic functions
created-at: Exported generic functions
created-at: Exported generic functions
created-at: Exported generic functions

D
data: Exported generic functions
data: Exported generic functions
day: Exported generic functions
day: Exported generic functions
decode-account: Internal functions
decode-application: Internal functions
decode-attachment: Internal functions
decode-card: Internal functions
decode-context: Internal functions
decode-emoji: Internal functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-entity: Exported generic functions
decode-image-metadata: Internal functions
decode-instance: Internal functions
decode-mention: Internal functions
decode-metadata: Internal functions
decode-notification: Internal functions
decode-push-subscription: Internal functions
decode-relationship: Internal functions
decode-report: Internal functions
decode-results: Internal functions
decode-status: Internal functions
decode-tag: Internal functions
decode-tag-history: Internal functions
decode-user-list: Internal functions
decode-video-metadata: Internal functions
default-headers: Exported generic functions
default-headers: Exported generic functions
define-entity: Internal macros
delete-notification: Exported generic functions
delete-notification: Exported generic functions
delete-notification: Exported generic functions
delete-notification: Exported generic functions
delete-status: Exported generic functions
delete-status: Exported generic functions
delete-status: Exported generic functions
delete-subscription: Exported generic functions
delete-subscription: Exported generic functions
delete-user-list: Exported generic functions
delete-user-list: Exported generic functions
descendants: Exported generic functions
descendants: Exported generic functions
description: Exported generic functions
description: Exported generic functions
description: Exported generic functions
description: Exported generic functions
display-name: Exported generic functions
display-name: Exported generic functions
domain-blocking: Exported generic functions
domain-blocking: Exported generic functions
duration: Exported generic functions
duration: Exported generic functions

E
email: Exported generic functions
email: Exported generic functions
emojis: Exported generic functions
emojis: Exported generic functions
emojis: Exported generic functions
endpoint: Exported generic functions
endpoint: Exported generic functions

F
favourite: Exported generic functions
favourite: Exported generic functions
favourite: Exported generic functions
favourited: Exported generic functions
favourited: Exported generic functions
favouriters: Exported generic functions
favouriters: Exported generic functions
favouriters: Exported generic functions
favourites: Exported generic functions
favourites: Exported generic functions
favourites-count: Exported generic functions
favourites-count: Exported generic functions
fields: Exported generic functions
fields: Exported generic functions
find-account: Exported generic functions
find-account: Exported generic functions
find-list: Exported generic functions
find-list: Exported generic functions
find-notification: Exported generic functions
find-notification: Exported generic functions
find-results: Exported generic functions
find-results: Exported generic functions
find-status: Exported generic functions
find-status: Exported generic functions
focus: Exported generic functions
focus: Exported generic functions
follow: Exported generic functions
follow: Exported generic functions
follow: Exported generic functions
follow: Exported generic functions
follow-remote: Exported generic functions
follow-remote: Exported generic functions
follow-remote: Exported generic functions
follow-requests: Exported generic functions
follow-requests: Exported generic functions
followed-by: Exported generic functions
followed-by: Exported generic functions
followers-count: Exported generic functions
followers-count: Exported generic functions
following: Exported generic functions
following: Exported generic functions
following-count: Exported generic functions
following-count: