jami-docs

Forked version of Jami documentation, see wrycode.com/jami-docs-demo
git clone git://git.wrycode.com/wrycode/jami-docs.git
Log | Files | Refs

libjamiclient-documentation.md (1672B)


      1 # LRC documentation
      2 
      3 NOTE: Had to delete a lot of image links that were broken, so this
      4 page is pretty useless right now.
      5 
      6 *This page is a stub.*
      7 
      8 ### Introduction
      9 
     10 -   Lrc (Libringclient) is an interface between the clients and
     11 	the daemon. It ensures to get the same behaviour for all client
     12 	using it.
     13 
     14 note: red = missing feature.
     15 
     16 ### DatabaseManager
     17 
     18 -   this class is an interface between lrc and the sqlite database. This
     19 	class should not be called directly from the client.
     20 
     21 ### NewCallModel class and NewCall namespace
     22 
     23 -   NewCallModel is an interface used to manage the calls.
     24 
     25 
     26 -   When we need information about calls, members functions from the
     27 	model can return NewCall::Info.
     28 
     29 
     30 -   When we need to perform some operation on a call, we pass it callId
     31 	to the delegate performing the operation.
     32 
     33 
     34 -   note about the name : we are using New as prefix to avoid conflict
     35 	with the current CallModel and Call objects.
     36 
     37 ### ContactModel class and Contact namespace
     38 
     39 -   ContactModel is an interface to manage the contacts.
     40 
     41 -   When we need information about contact(s), members functions from
     42 	the model can return Contact::Info
     43 
     44 -   When we need to perform some operation on a contact, we pass it uri
     45 	to the delegate performing the operation.
     46 
     47 ### ConversationModel class, Conversation namespace and Message namespace
     48 
     49 -   ConversationModel is an interface used to manage conversations
     50 	and messages.
     51 
     52 -   When we need information about some conversation(s), members
     53 	functions from the model can return Conversation::Info.
     54 	Conversation::Info contains Messages.
     55 
     56 -   note about Message : so far, we didn't need a MessageModel, but this
     57 	could be come soon.