package calculon

You can search for identifiers within the package.

in-package search v0.2.0

calculon
- Calculon
  - Command
  - Config
  - Core
    
    S
    
    I
    
    Io
  - Log
  - Lwt_err
  - Plugin
    
    Set
  - Plugin_factoids
  - Plugin_history
  - Plugin_social
  - Plugin_state
  - Plugin_vote
  - Prelude
    
    Rand_distrib
    
    StrMap
  - Run_main
  - Signal
    
    Send_ref
  - Talk
calculon.extras
- Calculon_extras
  - Irclog
  - Plugin_markcough
    
    Gen
    
    Parse_logs
    
    Table

Legend:
Library
Module
Module type
Parameter
Class
Class type

Social: keeps a register "nick -> informations" up-to-date. The type contact can be extended to store new informations.

One must then extend the function contacts_of_json and json_of_contact to handle the new fields (and deal with the case where we import old JSON values that don't have the new fields, e.g. by using a default value).

The data stored in the contacts base are usually automatically updated by callbacks defined in Social (thanks to Signal.on).

type to_tell = {

from : string;
on_channel : string;
msg : string;
tell_after : float option;
(*
optional; not before this deadline (UTC)
*)

}

type contact = {

last_seen : float;
to_tell : to_tell list;
ignore_user : bool;

}

type state

val data : state -> string -> contact

val set_data : state -> ?force_sync:bool -> string -> contact -> unit

val plugin : Plugin.t