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.cohttp
- EzCohttp
  - Base
  - Interface
  - Legacy
ez_api.cohttp_base
- EzCohttp_base
  - Make
    
    Client
ez_api.cohttp_lwt
- EzCohttp_lwt
  - Base
  - Interface
  - Legacy
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.icohttp
- EzReq
  - Interface
  - Legacy
ez_api.icohttp_lwt
- EzReq_lwt
  - Interface
  - Legacy
ez_api.iserver_cohttp
- EzServer
ez_api.iserver_default
- EzServer
ez_api.loads_offset
- EzLoads_offset
ez_api.lwt_unix
- EzLwtSys
ez_api.md5
- EzHash
ez_api.openAPI
- EzOpenAPI
  - Encoding
  - Makers
  - Types
ez_api.ppx_common
- Ppx_common
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.request_verbose
- Verbose
ez_api.sendgrid_encoding
- EzSendgrid_encoding
- EzSendgrid_types
ez_api.sendgrid_services
- EzSendgrid_services
ez_api.server
- EzAPIServer
ez_api.server_cohttp
- EzAPIServerCohttp
ez_api.server_session
- EzCookieServer
- EzSessionServer
  - Arg
    
    SessionArg
    
    SessionStore
  - Make
    
    S
    
    SessionArg
    
    SessionStore
    
    Service
  - 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
  - M
  - Make
    
    Encoding
    
    S
    
    Service
  - TYPES
    
    SessionArg
ez_api.session_client
- EzSessionClient
  - Make
    
    S
    
    Service
    
    _
    
    Legacy
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

module _ : EzReq_S.S

Signature

type user_id = S.user_id

See EzSession.TYPES.SessionArg.user_id.

type user_info = S.user_info

See EzSession.TYPES.SessionArg.user_info.

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

See EzSession.TYPES.auth.

module Service : 
  EzSession.M with type user_id = user_id and type user_info = user_info

See EzSession.Make

type login_error = [

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

]

Error that could be raised by login request.

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

Performs request to the server's authentication service if actual state is set to disconnected and calls callback on the response result. If state is set to connected or authenticated, then callback is called on actual connection/authentication status without performing request, unless token is specified.

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) Stdlib.result ->
    unit) ->
  unit

Performs request to the server's login service. If actual state is set to disconnected, then firstly, it performs connect request. If connect request returns authentication information for different user (if token or cookies wasn't updated) or if other user is already autenticated, it performs logout for this user, and retry logining. If user is connected but not authenticated, it constructs challenge reply by using user's login and password or uses foreign user information to authenticate. Calls callback on authentification status.

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

Performs request to the server's logout service if actual state is set to authenticated. After this step, state is set to connected. Callback is called with Ok true if logout was successfully performed. If previous state wasn't set to authenticated, then callback is called with Ok false.

val disconnected : unit -> unit

Tell the network layer that we think that the session has ended (a request probably returned an error status for missing auth). Since the state is kept internally, we have to do this first to trigger a full reconnection by `login`.

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

Returns authentication headers depending on S.token_kind for client requests. It doesn't include cookies because cookies are automatically added by browser.

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

Gets current authentication status, if exists.