The cl-dropbox Reference Manual

Table of Contents

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

The cl-dropbox Reference Manual

This is the cl-dropbox Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 10:53:58 2020 GMT+0.

• Introduction  What cl-dropbox is all about
• Systems  The systems documentation
• Files  The files documentation
• Packages  The packages documentation
• Definitions  The symbols documentation
• Indexes  Concepts, functions, variables and data types

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

1 Introduction

Common Lisp Client for the Dropbox API.

Access your dropbox account through Common Lisp.

Go to https://www.dropbox.com/developers/apps and create an app to
get credentials.

cl-oauth complains if the content type is not text.
(push '("application" . "x-www-form-urlencoded") drakma:*text-content-types*)

(ql:quickload :cl-dropbox)
(in-package :cl-dropbox)

(set-credentials :key "my-api-key" :secret "my-api-secret")

Obtain request token
(get-request-token)

Authorize your app
(authorize-app)

Obtain access token
(get-access-token)

Use the API
(get-account-info)


TODO

 - Implement missing API methods
 - Code refactoring

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

2 Systems

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

• The cl-dropbox system  

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

2.1 cl-dropbox

Author

Jose Pereira <jsmpereira@gmail.com>

Description

Common Lisp Client for the Dropbox API.

Dependencies
Source

cl-dropbox.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.

• Lisp files  

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

3.1 Lisp

• The cl-dropbox.asd file  
• The cl-dropbox/package.lisp file  
• The cl-dropbox/cl-dropbox.lisp file  

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

3.1.1 cl-dropbox.asd

Location

cl-dropbox.asd

Systems

cl-dropbox (system)

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

3.1.2 cl-dropbox/package.lisp

Parent

cl-dropbox (system)

Location

package.lisp

Packages

cl-dropbox

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

3.1.3 cl-dropbox/cl-dropbox.lisp

Dependency

package.lisp (file)

Parent

cl-dropbox (system)

Location

cl-dropbox.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.

• The cl-dropbox package  

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

4.1 cl-dropbox

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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

• Exported definitions  
• Internal definitions  

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

5.1 Exported definitions

• Exported functions  

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

5.1.1 Functions

Function: authorize-app ()
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: create-folder &key PATH ROOT DECODE

Creates a folder.

Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: delete-content &key PATH ROOT DECODE

Deletes a file or folder.

Package

cl-dropbox

Source

cl-dropbox.lisp (file)

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

Function: get-access-token ()
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: get-account-info &key DECODE

Retrieves information about the user’s account.

Package

cl-dropbox

Source

cl-dropbox.lisp (file)

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

Function: get-metadata &key PATH ROOT DECODE

Retrieves file and folder metadata.

Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: get-request-token ()
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: get-revisions &key PATH ROOT DECODE

Obtains metadata for the previous revisions of a file.

Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: media &key PATH ROOT DECODE

Returns a link directly to a file.

Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: restore &key PATH REV ROOT DECODE

Restores a file path to a previous revision.

Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: set-credentials &key KEY SECRET
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: shares &key PATH ROOT DECODE

Creates and returns a shareable link to files or folders.

Package

cl-dropbox

Source

cl-dropbox.lisp (file)

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

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

5.2 Internal definitions

• Internal special variables  
• Internal functions  

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

5.2.1 Special variables

Special Variable: *access-token*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *account-info-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *api-content*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *api-root*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

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

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *consumer-token*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *create-folder-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *delete-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *files-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

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

cl-dropbox

Source

cl-dropbox.lisp (file)

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

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *media-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *metadata-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *request-token*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *restore-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *revisions-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *search-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *shares-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Special Variable: *thumbnails-uri*
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

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

5.2.2 Functions

Function: encode-path PATH
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

Function: handle-response BODY STATUS &optional DECODE
Package

cl-dropbox

Source

cl-dropbox.lisp (file)

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

Appendix A Indexes

• Concept index  
• Function index  
• Variable index  
• Data type index  

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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section
C
cl-dropbox.asd: The cl-dropbox․asd file
cl-dropbox/cl-dropbox.lisp: The cl-dropbox/cl-dropbox․lisp file
cl-dropbox/package.lisp: The cl-dropbox/package․lisp file
F
File, Lisp, cl-dropbox.asd: The cl-dropbox․asd file
File, Lisp, cl-dropbox/cl-dropbox.lisp: The cl-dropbox/cl-dropbox․lisp file
File, Lisp, cl-dropbox/package.lisp: The cl-dropbox/package․lisp file
L
Lisp File, cl-dropbox.asd: The cl-dropbox․asd file
Lisp File, cl-dropbox/cl-dropbox.lisp: The cl-dropbox/cl-dropbox․lisp file
Lisp File, cl-dropbox/package.lisp: The cl-dropbox/package․lisp file
Jump to:   C   F   L  

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

A.2 Functions

Jump to:   A   C   D   E   F   G   H   M   R   S   T  
Index Entry  Section
A
authorize-app: Exported functions
C
create-folder: Exported functions
D
delete-content: Exported functions
do-search: Exported functions
E
encode-path: Internal functions
F
Function, authorize-app: Exported functions
Function, create-folder: Exported functions
Function, delete-content: Exported functions
Function, do-search: Exported functions
Function, encode-path: Internal functions
Function, get-access-token: Exported functions
Function, get-account-info: Exported functions
Function, get-file: Exported functions
Function, get-metadata: Exported functions
Function, get-request-token: Exported functions
Function, get-revisions: Exported functions
Function, handle-response: Internal functions
Function, media: Exported functions
Function, restore: Exported functions
Function, set-credentials: Exported functions
Function, shares: Exported functions
Function, thumbnails: Exported functions
G
get-access-token: Exported functions
get-account-info: Exported functions
get-file: Exported functions
get-metadata: Exported functions
get-request-token: Exported functions
get-revisions: Exported functions
H
handle-response: Internal functions
M
media: Exported functions
R
restore: Exported functions
S
set-credentials: Exported functions
shares: Exported functions
T
thumbnails: Exported functions
Jump to:   A   C   D   E   F   G   H   M   R   S   T  

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

A.3 Variables

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

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section
C
cl-dropbox: The cl-dropbox system
cl-dropbox: The cl-dropbox package
P
Package, cl-dropbox: The cl-dropbox package
S
System, cl-dropbox: The cl-dropbox system
Jump to:   C   P   S