This is the studio-client Reference Manual, version 1.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:58:42 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
studio-clientA client library for the Studio image hosting service
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
zlib
1.1.0
documentation-utils (system).
north-core (system).
babel (system).
com.inuoe.jzon (system).
package.lisp (file).
client.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
studio-client/studio-client.asdstudio-client/package.lispstudio-client/client.lispstudio-client/documentation.lispstudio-client/client.lisppackage.lisp (file).
studio-client (system).
api-base (reader method).
author (reader method).
author (reader method).
client (class).
cover (reader method).
(setf cover) (writer method).
created (reader method).
(setf created) (writer method).
delete (method).
delete (method).
description (reader method).
description (reader method).
(setf description) (writer method).
(setf description) (writer method).
file-content (method).
file-url (method).
files (reader method).
(setf files) (writer method).
galleries (method).
gallery (method).
gallery (class).
id (reader method).
id (reader method).
initialize-instance (method).
make-gallery (method).
make-upload (method).
print-object (method).
print-object (method).
save (method).
save (method).
tags (reader method).
(setf tags) (writer method).
title (reader method).
(setf title) (writer method).
upload (method).
upload (class).
uploads (method).
uploads (method).
url (reader method).
url (reader method).
visibility (reader method).
(setf visibility) (writer method).
arrangement (reader method).
(setf arrangement) (writer method).
decode-radiance-payload (function).
parse-gallery (function).
parse-upload (function).
plist->params (function).
post (generic function).
post-file (method).
studio-client/documentation.lispclient.lisp (file).
studio-client (system).
Packages are listed by definition order.
studio-clientorg.shirakumo.studio.client
common-lisp.
api-base (generic reader).
author (generic reader).
client (class).
cover (generic reader).
(setf cover) (generic writer).
created (generic reader).
(setf created) (generic writer).
delete (generic function).
description (generic reader).
(setf description) (generic writer).
file-content (generic function).
file-url (generic function).
files (generic reader).
(setf files) (generic writer).
galleries (generic function).
gallery (generic function).
gallery (class).
id (generic reader).
make-gallery (generic function).
make-upload (generic function).
save (generic function).
tags (generic reader).
(setf tags) (generic writer).
title (generic reader).
(setf title) (generic writer).
upload (generic function).
upload (class).
uploads (generic function).
url (generic reader).
visibility (generic reader).
(setf visibility) (generic writer).
arrangement (generic reader).
(setf arrangement) (generic writer).
decode-radiance-payload (function).
parse-gallery (function).
parse-upload (function).
plist->params (function).
post (generic function).
post-file (generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns the base API URL that the client will send API requests to.
See CLIENT
Returns the name of the author of the object.
See GALLERY
See UPLOAD
Returns the ID of the upload that was set as the gallery’s cover image, if any.
See GALLERY
Returns the universal-time timestamp of when the upload was created.
See UPLOAD
Delete the given object on the Studio instance.
This may fail if the authenticated user lacks the necessary permissions.
See GALLERY
See UPLOAD
See CLIENT
Returns the object’s description string.
See GALLERY
See UPLOAD
Returns the file’s binary payload data as returned by the server.
Returns an unsigned-byte 8 vector.
This function will error if the requested file does not exist.
Returns the public URL to the file.
Accessor to the list of files of the upload.
Returned by the server are merely the file IDs, which you can
turn into URLs and payloads with FILE-URL and FILE-CONTENT
respectively.
If you want to add new files, add the pathname to the file at the
appropriate position in the file list.
Note that setting this will only change the local object. In order
to persist the changes, use SAVE.
See UPLOAD
See SAVE
See FILE-URL
See FILE-CONTENT
Retrieve a listing of existing galleries on the Studio instance.
Note that this may return less than the specified END if the server caps the number of galleries it returns (by default limited to 10).
See GALLERY
See CLIENT
Retrieve the gallery of the given author.
See GALLERY
See CLIENT
Returns an ID that identifies this object on Studio.
See GALLERY
See UPLOAD
Create a gallery for the authenticated user.
Note that this will fail if a gallery already exists.
This may fail if the authenticated user lacks the necessary permissions.
Returns a fresh GALLERY instance if successful.
See GALLERY
See CLIENT
Create a new upload.
FILES should be a list of pathnames to upload as the upload’s files.
VISIBILITY can be one of :PUBLIC :HIDDEN :PRIVATE.
This may fail if the authenticated user lacks the necessary permissions.
Returns a fresh UPLOAD instance if successful.
See UPLOAD
See CLIENT
Save potential changes made to the fields of the object on the Studio instance.
This may fail if the authenticated user lacks the necessary permissions.
Returns a fresh instance of the saved object as returned by the API.
See GALLERY
See UPLOAD
See CLIENT
Accessor to the list of tags the upload is marked with.
Note that setting this will only change the local object. In order
to persist the changes, use SAVE.
See UPLOAD
See SAVE
Accessor to the upload’s title.
Note that setting this will only change the local object. In order
to persist the changes, use SAVE.
See UPLOAD
See SAVE
Retrieve the upload with the given ID.
See UPLOAD
See CLIENT
Retrieve a list of uploads for the given user or gallery.
DATE should be a date string in the format "MM.YYYY".
Note that this may return less than the specified END if the server caps the number of uploads it returns (by default limited to 40).
See GALLERY
See CLIENT
See UPLOAD
Returns the public URL to the given object.
See GALLERY
See UPLOAD
Accessor to the visibility of the upload.
The value may be one of: :PUBLIC :HIDDEN :PRIVATE
Note that setting this will only change the local object. In order
to persist the changes, use SAVE.
See UPLOAD
See SAVE
The base client class for Studio connections.
To start, you should create an instance of this client with the appropriate
:API-BASE, which defaults to "https://studio.tymoon.eu/api/". Then use
North’s functions NORTH:INITIATE-AUTHENTICATION and NORTH:COMPLETE-AUTHENTICATION
to complete the authentication cycle.
See NORTH:CLIENT
See API-BASE
client.
| Initarg | Value |
|---|---|
:api-base | https://studio.tymoon.eu/api/ |
:request-token-uri | nil |
:authorize-uri | nil |
:access-token-uri | nil |
Representation of a user’s gallery in Studio.
See ID
See AUTHOR
See URL
See COVER
See DESCRIPTION
See MAKE-GALLERY
See GALLERY
See GALLERIES
See DELETE
See SAVE
Representation of an upload in a gallery on a Studio instance.
See ID
See URL
See TITLE
See AUTHOR
See TAGS
See CREATED
See VISIBILITY
See DESCRIPTION
See FILES
See MAKE-UPLOAD
See UPLOADS
See UPLOAD
:title
:created
:visibility
:arrangement
:description
:files
| Jump to: | (
A C D F G I M P S T U V |
|---|
| Jump to: | (
A C D F G I M P S T U V |
|---|
| Jump to: | A C D F I S T U V |
|---|
| Jump to: | A C D F I S T U V |
|---|
| Jump to: | C D F G P S U |
|---|
| Jump to: | C D F G P S U |
|---|