package ez_api

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package ez_api

ez_api
- EzAPI
  - Arg
    
    Ty
    
    Ty
  - Doc
  - Err
    
    IntMap
  - Error_codes
  - Legacy
  - Meth
  - Mime
  - Param
  - Path
  - Req
    
    StringMap
  - Security
    
    StringSet
  - Service
    
    IO
  - TYPES
  - Url
    
    TYPES
ez_api.debug_unix
- EzDebug
ez_api.encoding
- EzEncoding
  - Ezjsonm
ez_api.ezjsonm_unix
- Ezjsonm_interface
ez_api.facebook_auth
- Facebook
  - Encoding
  - Services
  - Types
ez_api.google_auth
- Google
  - Encoding
  - Services
  - Types
ez_api.iserver_default
- EzServer
ez_api.lwt_unix
- EzLwtSys
ez_api.md5
- EzHash
ez_api.openAPI
- EzOpenAPI
  - Encoding
  - Makers
  - Types
ez_api.req_default
- EzReq
  - Interface
  - Legacy
ez_api.req_lwt_default
- EzReq_lwt
  - Interface
  - Legacy
ez_api.request
- EzRequest
  - ANY
    
    Legacy
  - Make
    
    Legacy
    
    _
ez_api.request_lwt
- EzRequest_lwt
  - ANY
    
    Legacy
  - Make
    
    Legacy
    
    _
ez_api.sendgrid_encoding
- EzSendgrid_encoding
- EzSendgrid_types
ez_api.sendgrid_services
- EzSendgrid_services
ez_api.server
- EzAPIServer
ez_api.server_session
- EzCookieServer
- EzSessionServer
  - Arg
    
    SessionArg
    
    SessionStore
  - Make
    
    S
    
    SessionArg
    
    SessionStore
  - SessionStore
  - SessionStoreInMemory
  - UserStoreInMemory
    
    S
    
    SessionArg
    
    SessionStore
ez_api.server_utils
- EzAPIServerUtils
  - Answer
  - Directory
    
    MethMap
    
    Step
    
    StringMap
  - File
    
    FileString
  - GMTime
  - Ip
  - Legacy
  - StringMap
  - Timings
ez_api.session
- EzSession
  - Hash
  - Make
    
    Encoding
    
    S
    
    Service
  - TYPES
    
    SessionArg
ez_api.session_client
- EzSessionClient
  - Make
    
    S
ez_api.ws_server_cohttp
- WsCohttp
ez_api.ws_server_httpaf
- WsHttpaf
ez_api.ws_types
- EzWsCommon
  - S
  - Types

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module S : EzSession.TYPES.SessionArg

Signature

type nonrec auth = (S.user_id, S.user_info) EzSession.TYPES.auth

type login_error = [

| EzSession.TYPES.login_error
| EzSession.TYPES.connect_error
| EzSession.TYPES.logout_error
| `Too_many_login_attempts
| `Session_expired

]

val connect : 
  EzAPI.base_url ->
  ?token:string ->
  (((S.user_id, S.user_info) EzSession.TYPES.auth option,
     EzSession.TYPES.connect_error)
     result ->
    unit) ->
  unit

val login : 
  ?format:(string -> string) ->
  EzAPI.base_url ->
  ?login:string ->
  ?password:string ->
  ?foreign:(string * string) ->
  (((S.user_id, S.user_info) EzSession.TYPES.auth, login_error) result -> unit) ->
  unit

val logout : 
  EzAPI.base_url ->
  token:string ->
  ((bool, EzSession.TYPES.logout_error) result -> unit) ->
  unit

val disconnected : unit -> unit

val auth_headers : token:string -> (string * string) list

val get : unit -> (S.user_id, S.user_info) EzSession.TYPES.auth option