The cl-scribd Reference Manual

Table of Contents

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

The cl-scribd Reference Manual

This is the cl-scribd Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:32:09 2018 GMT+0.


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

1 Introduction

Common Lisp Client for the Scribd API.
http://www.scribd.com/developers

Setup:

(ql:quickload :cl-scribd)
(in-package :cl-scribd)
(setf *api-key* "my-api-key")

Basically consists of one macro for building api calls.
There are examples of most API calls in the code.

Structure: (build-api-call  )

Build the call: (build-api-call docs.getList ())
Use it: (docs.getList)

Something more elaborate:

Build: (build-api-call docs.getDownloadUrl (doc_id doc_type))
Call: (docs.getDownloadUrl :doc_id "60920304" :doc_type "original")

Result:
"

  
    
  
"


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 cl-scribd

Author

Jose Pereira <jsmpereira@gmail.com>

Description

Commong Lisp Client for the Scribd API.

Dependencies
Source

cl-scribd.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 cl-scribd.asd

Location

cl-scribd.asd

Systems

cl-scribd (system)


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

3.1.2 cl-scribd/package.lisp

Parent

cl-scribd (system)

Location

package.lisp

Packages

cl-scribd


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

3.1.3 cl-scribd/cl-scribd.lisp

Dependency

package.lisp (file)

Parent

cl-scribd (system)

Location

cl-scribd.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-scribd

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.


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *api-key*
Package

cl-scribd

Source

cl-scribd.lisp (file)

Special Variable: *api-secret*
Package

cl-scribd

Source

cl-scribd.lisp (file)


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

5.1.2 Macros

Macro: build-api-call FNAME (&rest PARAMS)
Package

cl-scribd

Source

cl-scribd.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *api-root*
Package

cl-scribd

Source

cl-scribd.lisp (file)


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

5.2.2 Functions

Function: build-api-sig PARAMS
Package

cl-scribd

Source

cl-scribd.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-scribd.asd: The cl-scribd<dot>asd file
cl-scribd/cl-scribd.lisp: The cl-scribd/cl-scribd<dot>lisp file
cl-scribd/package.lisp: The cl-scribd/package<dot>lisp file

F
File, Lisp, cl-scribd.asd: The cl-scribd<dot>asd file
File, Lisp, cl-scribd/cl-scribd.lisp: The cl-scribd/cl-scribd<dot>lisp file
File, Lisp, cl-scribd/package.lisp: The cl-scribd/package<dot>lisp file

L
Lisp File, cl-scribd.asd: The cl-scribd<dot>asd file
Lisp File, cl-scribd/cl-scribd.lisp: The cl-scribd/cl-scribd<dot>lisp file
Lisp File, cl-scribd/package.lisp: The cl-scribd/package<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   B   F   M  
Index Entry  Section

B
build-api-call: Exported macros
build-api-sig: Internal functions

F
Function, build-api-sig: Internal functions

M
Macro, build-api-call: Exported macros

Jump to:   B   F   M  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*api-key*: Exported special variables
*api-root*: Internal special variables
*api-secret*: Exported special variables

S
Special Variable, *api-key*: Exported special variables
Special Variable, *api-root*: Internal special variables
Special Variable, *api-secret*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-scribd: The cl-scribd system
cl-scribd: The cl-scribd package

P
Package, cl-scribd: The cl-scribd package

S
System, cl-scribd: The cl-scribd system

Jump to:   C   P   S