The avatar-api Reference Manual

This is the avatar-api Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 19:31:41 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 avatar-api

Get avatars from Gravatar, Google+ and others.

Author

Fernando Borretti

Home Page

https://github.com/eudoxia0/avatar-api

License

MIT

Long Description

# avatar-api

[![Build Status](https://travis-ci.org/eudoxia0/avatar-api.svg?branch=master)](https://travis-ci.org/eudoxia0/avatar-api)

avatar-api is a library for getting avatars from Gravatar, Google+ and others.

# Usage

“‘lisp
cl-user> (avatar-api:gravatar "jdoe@initech.com")
"http://www.gravatar.com/avatar/6aef61d98ad63bd1aaa89345eb150df2"
“‘

# License

Copyright (c) 2014 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies
  • crypto-shortcuts (system).
  • drakma (system).
  • cl-json (system).
Source

avatar-api.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 avatar-api/src

Source

avatar-api.asd.

Parent Component

avatar-api (system).

Child Component

avatar-api.lisp (file).


4 Files

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


4.1 Lisp


4.1.1 avatar-api/avatar-api.asd

Source

avatar-api.asd.

Parent Component

avatar-api (system).

ASDF Systems

avatar-api.

Packages

avatar-api-asd.


4.1.2 avatar-api/src/avatar-api.lisp

Source

avatar-api.asd.

Parent Component

src (module).

Packages

avatar-api.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 avatar-api-asd

Source

avatar-api.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.2 avatar-api

Source

avatar-api.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: google (userid)
Package

avatar-api.

Source

avatar-api.lisp.

Function: gravatar (email &optional size)
Package

avatar-api.

Source

avatar-api.lisp.

Function: tumblr (base-hostname &optional size)
Package

avatar-api.

Source

avatar-api.lisp.

Function: yahoo (userid)
Package

avatar-api.

Source

avatar-api.lisp.


6.1.2 Conditions

Condition: wrong-size
Package

avatar-api.

Source

avatar-api.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: size
Initargs

:size

Readers

size.

Writers

This slot is read-only.

Slot: allowed-sizes
Initargs

:allowed-size

Readers

allowed-size.

Writers

This slot is read-only.


6.2 Internals


6.2.1 Special variables

Special Variable: +tumblr-allowed-sizes+
Package

avatar-api.

Source

avatar-api.lisp.


6.2.2 Ordinary functions

Function: json-decode (stream)
Package

avatar-api.

Source

avatar-api.lisp.

Function: validate-gravatar-size (size)
Package

avatar-api.

Source

avatar-api.lisp.

Function: validate-tumblr-size (size)
Package

avatar-api.

Source

avatar-api.lisp.


6.2.3 Generic functions

Generic Reader: allowed-size (condition)
Package

avatar-api.

Methods
Reader Method: allowed-size ((condition wrong-size))
Source

avatar-api.lisp.

Target Slot

allowed-sizes.

Generic Reader: size (condition)
Package

avatar-api.

Methods
Reader Method: size ((condition wrong-size))
Source

avatar-api.lisp.

Target Slot

size.


Appendix A Indexes


A.1 Concepts