The cl-dropbox Reference Manual

This is the cl-dropbox Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:54:26 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-dropbox

Common Lisp Client for the Dropbox API.

Author

Jose Pereira <>

Dependencies
  • drakma (system).
  • cl-json (system).
  • cl-oauth (system).
  • cl-ppcre (system).
Source

cl-dropbox.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-dropbox/cl-dropbox.asd

Source

cl-dropbox.asd.

Parent Component

cl-dropbox (system).

ASDF Systems

cl-dropbox.


3.1.2 cl-dropbox/package.lisp

Source

cl-dropbox.asd.

Parent Component

cl-dropbox (system).

Packages

cl-dropbox.


3.1.3 cl-dropbox/cl-dropbox.lisp

Dependency

package.lisp (file).

Source

cl-dropbox.asd.

Parent Component

cl-dropbox (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-dropbox

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: authorize-app ()
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: create-folder (&key path root decode)

Creates a folder.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: delete-content (&key path root decode)

Deletes a file or folder.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: do-search (&key path query root decode)

Returns metadata for all files and folders that match the search query.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: get-access-token ()
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: get-account-info (&key decode)

Retrieves information about the user’s account.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: get-file (&key path root rev)

Downloads a file. Note that this call goes to the api-content server.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: get-metadata (&key path root decode)

Retrieves file and folder metadata.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: get-request-token ()
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: get-revisions (&key path root decode)

Obtains metadata for the previous revisions of a file.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: media (&key path root decode)

Returns a link directly to a file.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: restore (&key path rev root decode)

Restores a file path to a previous revision.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: set-credentials (&key key secret)
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: shares (&key path root decode)

Creates and returns a shareable link to files or folders.

Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: thumbnails (&key path root decode)

Gets a thumbnail for an image. Note that this call goes to the api-content server.

Package

cl-dropbox.

Source

cl-dropbox.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *access-token*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *account-info-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *api-content*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *api-root*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *auth-request-token-endpoint*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *consumer-token*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *create-folder-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *delete-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *files-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *get-access-token-endpoint*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *get-request-token-endpoint*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *media-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *metadata-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *request-token*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *restore-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *revisions-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *search-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *shares-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Special Variable: *thumbnails-uri*
Package

cl-dropbox.

Source

cl-dropbox.lisp.


5.2.2 Ordinary functions

Function: encode-path (path)
Package

cl-dropbox.

Source

cl-dropbox.lisp.

Function: handle-response (body status &optional decode)
Package

cl-dropbox.

Source

cl-dropbox.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   D   E   F   G   H   M   R   S   T  
Index Entry  Section

A
authorize-app: Public ordinary functions

C
create-folder: Public ordinary functions

D
delete-content: Public ordinary functions
do-search: Public ordinary functions

E
encode-path: Private ordinary functions

F
Function, authorize-app: Public ordinary functions
Function, create-folder: Public ordinary functions
Function, delete-content: Public ordinary functions
Function, do-search: Public ordinary functions
Function, encode-path: Private ordinary functions
Function, get-access-token: Public ordinary functions
Function, get-account-info: Public ordinary functions
Function, get-file: Public ordinary functions
Function, get-metadata: Public ordinary functions
Function, get-request-token: Public ordinary functions
Function, get-revisions: Public ordinary functions
Function, handle-response: Private ordinary functions
Function, media: Public ordinary functions
Function, restore: Public ordinary functions
Function, set-credentials: Public ordinary functions
Function, shares: Public ordinary functions
Function, thumbnails: Public ordinary functions

G
get-access-token: Public ordinary functions
get-account-info: Public ordinary functions
get-file: Public ordinary functions
get-metadata: Public ordinary functions
get-request-token: Public ordinary functions
get-revisions: Public ordinary functions

H
handle-response: Private ordinary functions

M
media: Public ordinary functions

R
restore: Public ordinary functions

S
set-credentials: Public ordinary functions
shares: Public ordinary functions

T
thumbnails: Public ordinary functions


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*access-token*: Private special variables
*account-info-uri*: Private special variables
*api-content*: Private special variables
*api-root*: Private special variables
*auth-request-token-endpoint*: Private special variables
*consumer-token*: Private special variables
*create-folder-uri*: Private special variables
*delete-uri*: Private special variables
*files-uri*: Private special variables
*get-access-token-endpoint*: Private special variables
*get-request-token-endpoint*: Private special variables
*media-uri*: Private special variables
*metadata-uri*: Private special variables
*request-token*: Private special variables
*restore-uri*: Private special variables
*revisions-uri*: Private special variables
*search-uri*: Private special variables
*shares-uri*: Private special variables
*thumbnails-uri*: Private special variables

S
Special Variable, *access-token*: Private special variables
Special Variable, *account-info-uri*: Private special variables
Special Variable, *api-content*: Private special variables
Special Variable, *api-root*: Private special variables
Special Variable, *auth-request-token-endpoint*: Private special variables
Special Variable, *consumer-token*: Private special variables
Special Variable, *create-folder-uri*: Private special variables
Special Variable, *delete-uri*: Private special variables
Special Variable, *files-uri*: Private special variables
Special Variable, *get-access-token-endpoint*: Private special variables
Special Variable, *get-request-token-endpoint*: Private special variables
Special Variable, *media-uri*: Private special variables
Special Variable, *metadata-uri*: Private special variables
Special Variable, *request-token*: Private special variables
Special Variable, *restore-uri*: Private special variables
Special Variable, *revisions-uri*: Private special variables
Special Variable, *search-uri*: Private special variables
Special Variable, *shares-uri*: Private special variables
Special Variable, *thumbnails-uri*: Private special variables