package bookaml

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Exceptions
Inner modules
Type definitions
Public functions and values
Public module types
Public functors

bookaml
- Bookaml_amazon
  - ENGINE
  - HTTPGETTER
    
    Monad
  - Locale
  - Make
    
    Httpgetter
    
    Monad
    
    Xmlhandler
  - XMLHANDLER
- Bookaml_book
- Bookaml_isbn
bookaml.ocamlnet
- Bookaml_amazon_ocamlnet

Legend:
Library
Module
Module type
Parameter
Class
Class type

Module providing facilities for finding information about books. It works by invoking the Amazon Product Advertising API, and therefore most of its functions require the associate tag, access key, and secret key available to registered users of Amazon Web Services.

Exceptions

exception No_response

exception No_match of Bookaml_isbn.t

Inner modules

module Locale : sig ... end

Definition of the various supported Amazon locales.

Type definitions

type credential_t = {

locale : Locale.t;
associate_tag : string;
access_key : string;
secret_key : string;

}

Credential for Amazon Web Services.

val sexp_of_credential_t : credential_t -> Ppx_sexp_conv_lib.Sexp.t

val credential_t_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> credential_t

type criteria_t

Search criteria expected by some ENGINE functions. The search criteria must be created beforehand by function make_criteria.

val sexp_of_criteria_t : criteria_t -> Ppx_sexp_conv_lib.Sexp.t

val criteria_t_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> criteria_t

Public functions and values

val make_credential : 
  locale:Locale.t ->
  associate_tag:string ->
  access_key:string ->
  secret_key:string ->
  credential_t

Constructs the AWS credential that is required for ENGINE functions.

val make_criteria : 
  ?title:string ->
  ?author:string ->
  ?publisher:string ->
  ?keywords:string ->
  unit ->
  criteria_t

Constructs the search criteria that may be given to ENGINE functions. The search criteria may consist of any combination of title, author, publisher, or generic keywords. If none are specified, exception Invalid_arg is raised.

Public module types

module type XMLHANDLER = sig ... end

module type HTTPGETTER = sig ... end

module type ENGINE = sig ... end

Public functors

module Make
  (Xmlhandler : XMLHANDLER)
  (Httpgetter : HTTPGETTER) : 
  ENGINE with type 'a monad_t = 'a Httpgetter.Monad.t