package ez_api

  1. Overview
  2. Docs
package ez_api
Legend:
Library
Module
Module type
Parameter
Class
Class type
type foreign_info = {
  1. foreign_origin : string;
  2. foreign_token : string;
}
type 'user_id session = {
  1. session_token : string;
  2. session_login : string;
  3. session_user_id : 'user_id;
  4. session_last : float;
  5. session_foreign : foreign_info option;
}
module type SessionArg = sig ... end
type ('user_id, 'user_info) auth = {
  1. auth_login : string;
  2. auth_user_id : 'user_id;
  3. auth_token : string;
  4. auth_user_info : 'user_info;
}
type auth_needed = {
  1. challenge_id : string;
  2. challenge : string;
}
type 'auth connect_response =
  1. | AuthOk of 'auth
  2. | AuthNeeded of auth_needed
type local_login_message = {
  1. login_user : string;
  2. login_challenge_id : string;
  3. login_challenge_reply : string;
}
type login_message =
  1. | Local of local_login_message
  2. | Foreign of foreign_info
type ('user_id, 'user_info) login_response =
  1. | LoginOk of ('user_id, 'user_info) auth
  2. | LoginWait of 'user_id
type login_error = [
  1. | `Bad_user_or_password
  2. | `User_not_registered
  3. | `Unverified_user
  4. | `Challenge_not_found_or_expired of string
  5. | `Invalid_session_login of string
]
type logout_error = [
  1. | `Invalid_session_logout of string
]
type connect_error = [
  1. | `Session_expired
  2. | `Invalid_session_connect of string
]