clohost

1.0.0

A client library for the Cohost API

About Clohost

This is a client implementation for the Cohost API. The API is not currently officially documented, so the work in this library was done via observation of how the existing site interacts with its API. It may break if changes are made by ASSC.

How To

Create a client instance and log in. If successful, your client will turn into an account and you'll be able to start making changes and querying for data. Please see the documentation for the account objects and other entitys in the API.

For something simple, you can make a new post with

(make-post (default-page *)
  :tags '("cohost api")
  :content "Posting with https://github.com/shinmera/clohost,
Hello @Shinmera!")

You can also edit it, reply to it, or destroy the post again. Again, please see the definition cross references for more information on what you can do.

If you'd like to save your session for later use, you can retrieve the token of the account, and then recreate it later via (make-instance 'client :token token).

System Information

Version: 1.0.0

Dependencies:

Author: Yukari Hafner

License: zlib

Homepage: https://shinmera.github.io/clohost/

Bug Tracker: https://github.com/shinmera/clohost/issues

Sources: https://github.com/shinmera/clohost.git

Definition Index

ORG.SHIRAKUMO.CLOHOST

No documentation provided.

EXTERNAL CLASS

ACCOUNT

Source

Representation of a user account.

A user account can own multiple pages and perform requests on behalf
of them.

See CLIENT (type)
See ENTITY (type)
See PAGES
See EMAIL
See DEFAULT-PAGE
See MOD-MODE
See READ-ONLY-P
See EMAIL-VERIFIED-P
See TWO-FACTOR-P
See NOTIFICATIONS

EXTERNAL CLASS

ATTACHMENT

Source

Representation of an attachment in a post.

See MAKE-POST
See ENTITY (type)
See KIND
See URL
See PREVIEW
See WIDTH
See HEIGHT
See FILE
See FILENAME
See CONTENT-TYPE
See CONTENT-LENGTH
See ALT-TEXT

EXTERNAL CLASS

CLIENT

Source

Representation of an API client for Cohost.

A logged in client will be an instance of ACCOUNT.

See REQUEST
See TOKEN
See LOGIN
See LOGOUT
See ACCOUNT

EXTERNAL CLASS

COMMENT

Source

Representation of a comment on a post.

See ENTITY (type)
See REPLY-TO
See POST
See REPLIES
See TIME
See TEXT
See DELETED-P
See HIDDEN-P
See AUTHOR
See INTERACTABLE-P
See EDITABLE-P
See HIDEABLE-P
See REPLY

EXTERNAL CLASS

ENTITY

Source

Base object representing a foreign object.

See ID
See CLIENT
See EDIT
See DESTROY

EXTERNAL CLASS

NOTIFICATION

Source

Representation of a notification toast.

See KIND
See TIME
See AUTHOR
See POST
See SHARE-POST
See COMMENT

EXTERNAL CLASS

PAGE

Source

Representation of a page on Cohost.

This is called a "project" internally by the API. It is effectively
a user in how the site operates, but in order to avoid confusion with
an account, which can own many pages, we call it a "page", just like
the UI refers to them.

See ENTITY (type)
See HANDLE
See DISPLAY-NAME
See TITLE
See DESCRIPTION
See AVATAR
See HEADER
See PRIVACY
See URL
See PRONOUNS
See FLAGS
See ASK-SETTINGS
See CONTACT-CARD
See POSTS
See NOTIFICATIONS
See MAKE-POST
See ASK
See ASKS
See FIND-POST

EXTERNAL CLASS

POST

Source

Representation of a post on a page.

See ENTITY (type)
See TITLE
See TIME
See STATE
See CONTENT-WARNINGS
See ADULT-P
See LIKED-P
See SHAREABLE-P
See PINNED-P
See COMMENTS-LOCKED-P
See SHARES-LOCKED-P
See RELATED-PAGES
See TAGS
See PAGE
See SHARE-TREE
See URL
See CONTENT
See TEXT
See COMMENTS
See OP
See SHARE
See REPLY

EXTERNAL CONDITION

CLOHOST-ERROR

Source

Error signalled when an API request fails.

See ENDPOINT
See PARAMETERS
See RESPONSE

EXTERNAL GENERIC-FUNCTION

ACTIVATED-P

OBJECT

Returns whether the account is activated.

See ACCOUNT (type)

EXTERNAL GENERIC-FUNCTION
(SETF ACTIVATED-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ADULT-P

OBJECT

Returns whether the post is marked as adult content.

See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF ADULT-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ALT-TEXT

OBJECT

Accesses the alt text of the attachment.

See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF ALT-TEXT)
- NEW-VALUE
- OBJECT
No documentation provided.
EXTERNAL GENERIC-FUNCTION
ASK
- PAGE
- CONTENT
- &KEY
- SOURCE
Source
```
Submit a new ask on another page.

See PAGE (type)
```

EXTERNAL GENERIC-FUNCTION

ASK-SETTINGS

OBJECT

Returns a plist describing the ask settings.

See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF ASK-SETTINGS)
- NEW-VALUE
- OBJECT
No documentation provided.
EXTERNAL GENERIC-FUNCTION
ASKS
- PAGE
Source
```
List asks for a page.

See PAGE (type)
```

EXTERNAL GENERIC-FUNCTION

AUTHOR

OBJECT

Returns the author page of the entity.

See NOTIFICATION (type)
See COMMENT (type)
See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF AUTHOR)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

AVATAR

OBJECT

Returns the URL to the page's avatar.

See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF AVATAR)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CLIENT

OBJECT

Returns the client with which the object was retrieved.

See ENTITY (type)

EXTERNAL GENERIC-FUNCTION
(SETF CLIENT)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

COMMENT

OBJECT

Returns the comment that was created, if any.

See NOTIFICATION (type)
See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF COMMENT)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

COMMENTS

POST

Source

List the comments on a post.

See POST (type)
See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF COMMENTS)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

COMMENTS-LOCKED-P

OBJECT

Returns whether the comments are locked on the post.

See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF COMMENTS-LOCKED-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CONTACT-CARD

OBJECT

Returns a list of contact cards.

See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF CONTACT-CARD)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CONTENT

OBJECT

Returns the post content as a list of blocks.

Each block can either be a string of text in markdown format, or an
ATTACHMENT instance.

See POST (type)
See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF CONTENT)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CONTENT-LENGTH

OBJECT

Accesses the length in octets of the attachment.

See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF CONTENT-LENGTH)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CONTENT-TYPE

OBJECT

Accesses the content-type of the attachment.

This is a mime-type string.

See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF CONTENT-TYPE)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CONTENT-WARNINGS

OBJECT

Returns a list of content warnings for the post.

See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF CONTENT-WARNINGS)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

DEFAULT-PAGE

OBJECT

Returns the default page of the account.

See PAGE (type)
See ACCOUNT (type)

EXTERNAL GENERIC-FUNCTION
(SETF DEFAULT-PAGE)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

DELETED-P

OBJECT

Returns whether the post was marked as deleted.

See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF DELETED-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

DESCRIPTION

OBJECT

Returns the description of the page.

This is markdown formatted text.

See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF DESCRIPTION)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

DESTROY

ENTITY

Source

Delete the given object.

See ENTITY (type)

EXTERNAL GENERIC-FUNCTION

DISPLAY-NAME

OBJECT

Returns the name that should be used for the page.

See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF DISPLAY-NAME)
- NEW-VALUE
- OBJECT
No documentation provided.
EXTERNAL GENERIC-FUNCTION
EDIT
- ENTITY
- &KEY
- TEXT
- HIDDEN-P
- TITLE
- CONTENT-WARNINGS
- ADULT-P
- TAGS
- DRAFT-P
- CONTENT
- LIKED-P
- DISPLAY-NAME
- DESCRIPTION
- URL
- PRONOUNS
- CONTACT-CARD
- DEFAULT-PAGE
Source
```
Edit properties of the given object.

The editable properties should be supplied via keyword arguments.

See ENTITY (type)
```

EXTERNAL GENERIC-FUNCTION

EDITABLE-P

OBJECT

Returns whether the comment can be edited.

See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF EDITABLE-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

EMAIL

OBJECT

Returns the email address of the account.

See ACCOUNT (type)

EXTERNAL GENERIC-FUNCTION
(SETF EMAIL)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

EMAIL-VERIFIED-P

OBJECT

Returns whether the account's email has been verified.

See ACCOUNT (type)

EXTERNAL GENERIC-FUNCTION
(SETF EMAIL-VERIFIED-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ENDPOINT

CONDITION

The endpoint that the request was made to.

See CLOHOST-ERROR

EXTERNAL GENERIC-FUNCTION

FILE

OBJECT

Accesses the file pathname of the attachment.

See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF FILE)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

FILENAME

OBJECT

Accesses the filename of the attachment.

See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF FILENAME)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

FIND-POST

ID
PAGE

Source

Find a particular post on a page.

See POST (type)
See PAGE (type)

EXTERNAL GENERIC-FUNCTION

FLAGS

OBJECT

Returns a list of flags set on the page.

See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF FLAGS)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

HANDLE

OBJECT

Returns the unique handle of the page.

See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF HANDLE)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION
(SETF HEADER)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

HEIGHT

OBJECT

Returns the height of the attachment.

See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF HEIGHT)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

HIDDEN-P

OBJECT

Returns whether the current page has marked the post as hidden.

See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF HIDDEN-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

HIDEABLE-P

OBJECT

Returns whether the comment can be hidden.

See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF HIDEABLE-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ID

OBJECT

Returns the ID of the object on the remote API.

See ENTITY (type)

EXTERNAL GENERIC-FUNCTION
(SETF ID)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

INTERACTABLE-P

OBJECT

Returns whether the comment can be interacted with from the default page.

See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF INTERACTABLE-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

KIND

OBJECT

Returns the type of entity this represents.

See NOTIFICATION (type)
See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF KIND)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

LIKED-P

OBJECT

Returns whether the post was liked from the current default page.

See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF LIKED-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

LOGOUT

CLIENT

Logs out of Cohost.

If successful, this will change the ACCOUNT back into a CLIENT and
return it.

See CLIENT (type)
See ACCOUNT (type)

EXTERNAL GENERIC-FUNCTION

MAKE-POST

PAGE
&KEY
TITLE
CONTENT
CONTENT-WARNINGS
TAGS
ADULT-P
DRAFT-P
SHARE
&ALLOW-OTHER-KEYS

Source

Create a new post on the given page.

The new post instance is returned.

CONTENT should either be a content block or a list of content
blocks. A content block can either be a STRING of markdown formatted
text, a PATHNAME to a file to upload, or an ATTACHMENT to upload.

SHARE, if provided, should be another post which this post will be a
share of.

If DRAFT-P is true, the post will be left in draft status and won't be
published. You'll have to EDIT the post later to publish it.

See ATTACHMENT (type)
See PAGE (type)

EXTERNAL GENERIC-FUNCTION
MOD-MODE
- OBJECT
```
?

See ACCOUNT (type)
```
EXTERNAL GENERIC-FUNCTION
(SETF MOD-MODE)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

NOTIFICATIONS

ACCOUNT
&KEY
START
END
PER-PAGE

Source

List notifications for a page.

See ACCOUNT (type)
See PAGE (type)
See NOTIFICATION (type)

EXTERNAL GENERIC-FUNCTION

OP

POST

Returns the original poster of the post.

This can be different from PAGE if the post is a share.

See POST (type)
See PAGE (type)

EXTERNAL GENERIC-FUNCTION

PAGE

OBJECT

Returns the page the entity is associated with.

See PAGE (type)
See POST (type)
See NOTIFICATION (type)

EXTERNAL GENERIC-FUNCTION
(SETF PAGE)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PAGES

OBJECT

Returns all the pages this account can edit.

See ACCOUNT (type)
See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF PAGES)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PARAMETERS

CONDITION

The parameters that were supplied to the request.

See CLOHOST-ERROR

EXTERNAL GENERIC-FUNCTION

PINNED-P

OBJECT

Returns whether the post is pinned to the top of the page.

See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF PINNED-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

POST

OBJECT

Returns he post this entity was made in relation to.

See NOTIFICATION (type)
See POST (type)
See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF POST)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

POSTS

PAGE
&KEY
START
END

Source

List posts from a page.

See PAGE (type)
See POST (type)

EXTERNAL GENERIC-FUNCTION

PREVIEW

OBJECT

Returns the URL at which a minified URL of this entity is accessible.

See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF PREVIEW)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PRIVACY

OBJECT

Returns the privacy setting of the page.

See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF PRIVACY)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PRONOUNS

OBJECT

Returns a string description of the page's preferred pronouns.

See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF PRONOUNS)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PUBLISHABLE-P

OBJECT

Returns whether the post can still be published.

See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF PUBLISHABLE-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

READ-ONLY-P

OBJECT

Returns whether the account is in read-only mode.

See ACCOUNT (type)

EXTERNAL GENERIC-FUNCTION
(SETF READ-ONLY-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION
(SETF RELATED-PAGES)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

REPLIES

OBJECT

Returns a list of replies that were made to this comment.

See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF REPLIES)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

REPLY

POST
TEXT
&KEY
REPLY-TO

Source

Reply to a post or comment.

See POST (type)
See COMMENT (type)

EXTERNAL GENERIC-FUNCTION

REPLY-TO

OBJECT

Returns the comment this comment is in reply to, if any.

See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF REPLY-TO)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

REQUEST

CLIENT
METHOD
ENDPOINT
&REST
ARGS

Perform an API request to Cohost.

METHOD can be one of:
  :GET
  :POST
  :PUT
  :DELETE
  :POSTJSON

Endpoint should be a path relative to the Cohost v1 API.

Signals a condition of type CLOHOST-ERROR if the API request fails.

Returns two values: the parsed payload and reply header alist.

See CLOHOST-ERROR
See CLIENT (type)

EXTERNAL GENERIC-FUNCTION

RESPONSE

CONDITION

The response body from the failed request.

See CLOHOST-ERROR

EXTERNAL GENERIC-FUNCTION
(SETF SHARE-POST)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION
(SETF SHARE-TREE)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

SHAREABLE-P

OBJECT

Returns whether the post can be shared on the current page.

See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF SHAREABLE-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

SHARES-LOCKED-P

OBJECT

Returns whether the sharing the post is restricted.

See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF SHARES-LOCKED-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

STATE

OBJECT

Returns the state of the post.

See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF STATE)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TEXT

OBJECT

Returns the plaintext of the entity.

See POST (type)
See COMMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF TEXT)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TIME

OBJECT

Returns the universal-time timstamp of when the entity was made.

See COMMENT (type)
See NOTIFICATION (type)
See POST (type)

EXTERNAL GENERIC-FUNCTION
(SETF TIME)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TITLE

OBJECT

Returns the title of the entity.

For a page, this is its tagline, internally called "dek".

See POST (type)
See PAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF TITLE)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TOKEN

CLIENT

Accesses the login token used to connect.

See CLIENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF TOKEN)
- VALUE
- CLIENT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TWO-FACTOR-P

OBJECT

Returns whether two-factor authentication is active for the account.

See ACCOUNT (type)

EXTERNAL GENERIC-FUNCTION
(SETF TWO-FACTOR-P)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

URL

OBJECT

Returns the URL at which this entity is accessible.

See POST (type)
See PAGE (type)
See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF URL)
- NEW-VALUE
- OBJECT
No documentation provided.

EXTERNAL GENERIC-FUNCTION

WIDTH

OBJECT

Returns the width of the attachment.

See ATTACHMENT (type)

EXTERNAL GENERIC-FUNCTION
(SETF WIDTH)
- NEW-VALUE
- OBJECT
No documentation provided.