SIP SIMPLE Client SDK

= Buddy list =

[[TOC(Design*, depth=1)]]

 * Account

 * Address-book

 * Buddy list

 * Watcher list

 * Presence rules

[[Image(sipsimple-buddy-list-design.png,width=600)]]

== Account ==

 * GET XCAP documents xcap-caps, pres-rules, resource-lists, pidf-manipulation, rls-services

 * Sends Publish for event presence

 * Maintains a '''Presentity''' attributed that is sent as body to Publish

 * Sends Subscribe for event presence.info

 * Sends Subscribe for event presence with Supported=eventlist

== Buddy lists ==

Contains list of buddies. The buddylist is indexed by SIP URIs. Additional one can store full name or other attributes. Based on NOTIFY for event=presence each buddy has a '''Presentity''' attribute that contains published information. GUI displays parts of it.

Buddy list is stored in resource-lists XCAP document. If RLS is used, a RLS document that can contains a list of discrete SIP URIs is built and PUT on the server.

== Watcher lists ==

Built based on the body of NOTIFY for event=presence.winfo.

== Presence rules ==

Based on NOTIFY for event watcher.info we update the policy and PUT pres-rules document on the XCAP server.

== Icon exhange flow ==

Support in OpenXCAP server is necessary, see http://openxcap.org/ticket/100

Publishing end-point, on change:

 1. Generate a random filename: XYZ

 1. Build URL http://xcap.example.com/xcap-root/icon/users/sip:alice@example.com/XYZ.png

 1. HTTP PUT to xcap server

 1. Update <icon> element of pidf and PUBLISH new pidf

 1. HTTP GET for xcap-directory and locate previously uploaded icons

 1. HTTP DELETE any previous icon files

On reboot:

 1. HTTP GET for xcap-directory and locate previously uploaded icon (e.g. XYZ)

 1. HTTP GET http://xcap.example.com/xcap-root/icon/users/sip:alice@example.com/XYZ.png

Subscribing end-point:

 1. Parse <icon> element of pidf received in Notify

 2. HTTP GET http://xcap.example.com/xcap-root/icon/users/sip:alice@example.com/XYZ.png

 3. Cache picture and check periodically