==============
Private Events
==============
Event creation
--------------
user0 request the creation of an event, the buddy has to send this iq in order to create the event.
+-------------------+--------------+----------------+--------------------------------------+
| **Tag** | **Required** | **Value** | **Description** |
+===================+==============+================+======================================+
| **x**:type | true | event_creation | Fixed value for the message |
+-------------------+--------------+----------------+--------------------------------------+
| **x**:payload | true | json object | Represents message content |
+-------------------+--------------+----------------+--------------------------------------+
| **payload**:event | true | Event object | DOC :doc:`event_objects_description` |
+-------------------+--------------+----------------+--------------------------------------+
**Client request example:**
.. code-block:: xml
event_creation
{
"event":
{
"jid": "event-jid",
"occupants": [
{
"jabberId":"user0",
"isAdmin": true,
"isOwner": true
},
{
"jabberId":"user1",
"isAdmin": true
},
{
"jabberId":"user2"
},
{
"jabberId":"user3"
}
],
"start_date": "datetime",
"end_date": "datetime",
"roomname": "event_name",
"subject": "description",
"event_type": "closed",
"label": "label",
"location": {
"lat": 42,
"lng": 12,
"location_name": "locale",
"street_address": "via"
},
"members_can_invite": true,
"members_can_chat": true
}
}
**Buddy action:**
.. code-block:: xml
[
{jabberId: "user0", "state": "maybe", isAdmin:true, isOwner = true},
{jabberId: "user1", "state": "maybe", isAdmin:true, isOwner = false},
{jabberId: "user2", "state": "maybe", isAdmin:false, isOwner = false},
{jabberId: "user3", "state": "maybe", isAdmin:false, isOwner = false}
]
datetime
datetime
event_name
description
event
closed
{"lat":42, "lng":12, "location_name":"locale", "street_address":"via"}
true
true
user0
user1
user2
user3
Configuration change
--------------------
Only admin can require changes
Someone send the new configuration to the buddy, the the buddy has to send this message to change the configuration.
+-------------------+--------------+----------------+--------------------------------------+
| **Tag** | **Required** | **Value** | **Description** |
+===================+==============+================+======================================+
| **x**:type | true | event_creation | Fixed value for the message |
+-------------------+--------------+----------------+--------------------------------------+
| **x**:payload | true | json object | Represents message content |
+-------------------+--------------+----------------+--------------------------------------+
| **payload**:event | true | Event object | DOC :doc:`event_objects_description` |
+-------------------+--------------+----------------+--------------------------------------+
**Client request example:**
.. code-block:: xml
event_change_configuration
{
"event": {
"jid": "event-jid",
"occupants":
[{
"*jabberId":"user4",
"state": "maybe",
"action": "add",
"isAdmin": true
},{
"jabberId":"user2",
"state": "maybe",
"action": "remove"
}],
"start_date": "datetime",
"end_date": "datetime",
"roomname": "event_name",
"subject": "description",
"event_type": "closed",
"label": "label",
"location": {
"lat": 42,
"lng": 12,
"location_name": "locale",
"street_address": "via"
},
"members_can_invite": true,
"members_can_chat": true
}
}
**Buddy action:**
The buddy must only send changed tags
-------------------------------------
.. code-block:: xml
[
{jabberId: "user0", "state": "maybe", isAdmin:true, isOwner = true},
{jabberId: "user1", "state": "maybe", isAdmin:true, isOwner = false},
{jabberId: "user3", "state": "maybe", isAdmin:false, isOwner = false}
{jabberId: "user4", "state": "maybe", isAdmin:true, isOwner = false}
]
datetime
datetime
event_name
description
event
closed
{"lat":42, "lng":12, "location_name":"locale", "street_address":"via"}
true
true
user0
user1
user3
user4
Occupants changes
-----------------
All members can require this changes.
Someone send the new configuration to the buddy, the the buddy has to send this message to change the occupants list configuration.
+-------------------+--------------+----------------+--------------------------------------+
| **Tag** | **Required** | **Value** | **Description** |
+===================+==============+================+======================================+
| **x**:type | true | event_creation | Fixed value for the message |
+-------------------+--------------+----------------+--------------------------------------+
| **x**:payload | true | json object | Represents message content |
+-------------------+--------------+----------------+--------------------------------------+
| **payload**:event | true | Event object | DOC :doc:`event_objects_description` |
+-------------------+--------------+----------------+--------------------------------------+
**Client request example:**
.. code-block:: xml
event_change_occupants
{
"event":
{
"jid": "event-jid",
"occupants":
[{
"*jabberId":"user3",
"action": "add"
}]
}
}
**Buddy action:**
The buddy must only send changed tags
-------------------------------------
.. code-block:: xml
[
{jabberId: "user0", "state": "maybe", isAdmin:true},
{jabberId: "user1", "state": "maybe", isAdmin:false},
{jabberId: "user3", "state": "maybe", isAdmin:false},
{jabberId: "user4", "state": "maybe", isAdmin:true}
]
user0
user1
user3
user4