package bookaml
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=7af47997c54d37239a8249697720796f26f529bf602ea5fb3c211ae4f0f8b51f
md5=d18eec930a00a2ba442531d3cc12dea1
doc/bookaml/Bookaml_amazon/index.html
Module Bookaml_amazon
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_match of Bookaml_isbn.t
Inner modules
module Locale : sig ... end
Definition of the various supported Amazon locales.
Type definitions
type credential = {
locale : Locale.t;
associate_tag : string;
access_key : string;
secret_key : string;
}
Credential for Amazon Web Services.
val sexp_of_credential : credential -> Sexplib0.Sexp.t
val credential_of_sexp : Sexplib0.Sexp.t -> credential
Search criteria expected by some ENGINE
functions. The search criteria must be created beforehand by function make_criteria
.
val sexp_of_criteria : criteria -> Sexplib0.Sexp.t
val criteria_of_sexp : Sexplib0.Sexp.t -> criteria
Public functions and values
val make_credential :
locale:Locale.t ->
associate_tag:string ->
access_key:string ->
secret_key:string ->
credential
Constructs the AWS credential that is required for ENGINE
functions.
val make_criteria :
?title:string ->
?author:string ->
?publisher:string ->
?keywords:string ->
unit ->
criteria
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 = 'a Httpgetter.Monad.t