doc/roster_format.txt
author Matthew Wild <mwild1@gmail.com>
Mon, 20 Feb 2023 18:10:15 +0000
branch0.12
changeset 12898 0598d822614f
parent 132 9a4aa57af367
permissions -rw-r--r--
mod_websocket: Fire pre-session-close event (fixes #1800) This event was added in a7c183bb4e64 and is required to make mod_smacks know that a session was intentionally closed and shouldn't be hibernated (see fcea4d9e7502). Because this was missing from mod_websocket's session.close(), mod_smacks would always attempt to hibernate websocket sessions even if they closed cleanly. That mod_websocket has its own copy of session.close() is something to fix another day (probably not in the stable branch). So for now this commit makes the minimal change to get things working again. Thanks to Damian and the Jitsi team for reporting.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
100
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     1
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     2
This file documents the structure of the roster object.
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     3
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     4
table roster {
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     5
  [string bare_jid] = roster_item
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     6
}
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     7
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     8
table roster_item {
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     9
  string subscription = "none" | "to" | "from" | "both"
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    10
  string name = Opaque string set by client. (optional)
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    11
  set groups = a set of opaque strings set by the client
132
9a4aa57af367 Roster updates
Waqas Hussain <waqas20@gmail.com>
parents: 131
diff changeset
    12
  boolean ask = nil | "subscribe" - a value of true indicates subscription is pending
100
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    13
}
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    14
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    15
The roster is available as
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    16
 hosts[host].sessions[username].roster
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    17
and a copy is made to session.roster for all sessions.
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    18
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    19
All modifications to a roster should be done through the rostermanager.