GSD WebDAV DOCUframe events
xDav_AuthenticateUser_AddOn
This AddOn is used to check the user corectness. It is possible to check if the name of the user is OK, or if that particular user has an available license.
| Field | Type | Description |
|---|---|---|
| &error | STRING | description of the occured error |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: - INT -1 - error, 0 - OK | ||
xDav_CreateAddressbook_AddOn
AddOn allows to create new address book.
| Field | Type | Description |
|---|---|---|
| &addressbookObject | DBOBJECT | object of created address book |
| &error | STRING | description of the occured error |
| &data | DBSTRINGSET | input data, this set contains the list of members of new address book and the specific data that will be set in each member |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -1 - error, 0 - OK | ||
xDav_CreateCalendar_AddOn
AddOn allows to create new calendar.
| Field | Type | Description |
|---|---|---|
| &calendarObject | DBOBJECT | object of created calendar |
| &error | STRING | description of the occured error |
| &data | DBSTRINGSET | input data, this set contains the list of members of new address book and the specific data that will be set in each member |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -1 - error, 0 - OK | ||
xDav_CreateIcsFromIcsData_AddOn
AddOn allows to create new termin based on given data.
| Field | Type | Description |
|---|---|---|
| &newIcsData | DBSTRINGSET | serialised data of newly created termin |
| &error | STRING | description of the occured error |
| &icsData | DBSTRINGSET | data based on which new termin is created |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -1 - error, 0 - OK | ||
xDav_CreateVCard_AddOn
AddOon allows to create new VCard.
| Field | Type | Description |
|---|---|---|
| &vcard | xDavVCard | object of created vcard |
| &error | STRING | description of the occured error |
| &data | DBSTRINGSET | data based on which new vcard is created |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| &bigContent | STRING | BASE64 of image |
| Return: INT -1 - error, 0 - OK | ||
xDav_DeleteCalendar_AddOn
AddOn allwos to delete a calendar with the given OID.
| Field | Type | Description |
|---|---|---|
| &error | STRING | description of the occured error |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -1 - error, 0 - OK | ||
xDav_DeleteIcs_AddOn
AddOn allows to delete a term with given UUID. Before deletion security rights are checked.
| Field | Type | Description |
|---|---|---|
| &error | STRING | description of the occured error |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -4 - forbidden, -1 - unknown error, 0 - OK | ||
xDav_DeleteVCard_AddOn
AddOn allows to delete a vCard. The way to find specific vCard to delete can be customized via AddOn "xDav_FindVCards_AddOn". Before deletion security rights are checked.
| Field | Type | Description |
|---|---|---|
| &error | STRING | description of the occured error |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -4 - forbidden, -1 - unknown error, 0 - OK | ||
xDav_FindAddressbooks_AddOn
AddOn allows to get a list of address books with the given parameters such as UUID, owner ID or the name. Parameters can be passed in any combination but at least one parameter is mandatory.
| Field | Type | Description |
|---|---|---|
| &addressbooks | xDavAddressbookSet | set of found address books |
| &error | STRING | description of the occured error |
| &whereSet | DBSTRINGSET | string set with query parameters, such as UUID of the address book, owner ID or the name of the book itself |
| Return: INT -2 - no books were found, -1 - unknown error, 0 - OK | ||
xDav_FindCalendarByOidOrID_AddOn
AddOn allows to get a calendar with the given object OID or the ID. After calendar was found, function determines privileges to this object based on the security rights.
| Field | Type | Description |
|---|---|---|
| &calendar | xDavCalendar | object of the found calendar |
| &error | STRING | description of the occured error |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -2 - no calendar was found, -1 - unknown error, 0 - OK | ||
xDav_FindCalendarsByOwner_AddOn
AddOn allows to get the list of calendars for a specific owner. After calendars were found, function determines privileges to these objects based on the security rights.
| Field | Type | Description |
|---|---|---|
| &calendars | xDavCalendarSet | set of found calendars |
| &error | STRING | description of the occured error |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -1 - error, 0 - OK | ||
xDav_FindIcsesInCalendar_AddOn
AddOn allows to get the list of the termins for the specific calendar. At first it searches for the specific calendar with the given ID and then it takes termins for it.
| Field | Type | Description |
|---|---|---|
| &objects | GSDObjektSet | set of the found termins |
| &error | STRING | description of the occured error |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -1 - error, 0 - OK | ||
xDav_FindVCards_AddOn
AddOn allows to get the list of the vCards with the given parameters such as UUIDs or address book ID. Parameters can be passed as one UUID, the list of UUDIs or address book ID. At least one parameter is mandatory.
| Field | Type | Description |
|---|---|---|
| &vcards | xDavVCardSet | set of the found vCards |
| &error | STRING | description of the occured error |
| &whereSet | DBSTRINGSET | string set with query parameters, such as UUIDs of the address book or address book ID |
| Return: INT -1 - error, 0 - OK | ||
xDav_OidToIcsData_AddOn
AddOn allows to get the informations of the term with the given OID. Informations are returned in string set.
| Field | Type | Description |
|---|---|---|
| &icsData | DBSTRINGSET | string set with the informations of given term |
| String set includes these informations:-Member name "Event UID" - field "uuid"-Member name "Event OID" - field "oid"-Member name "Calendar ID" - field "calendarId"-Member name "Event content" - field "content"-Member name "Last store time" - field"updatedAt" | ||
| &error | STRING | description of the occured error |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -1 - error, 0 - OK | ||
xDav_UpdateCalendar_AddOn
AddOn allows to update given calendar with new data. These data are passed via string set.
| Field | Type | Description |
|---|---|---|
| &calendar | xDavCalendar | calendar that will be updated |
| &error | STRING | description of the occured error |
| &data | DBSTRINGSET | string set with new data |
| String set includes these informations:-Member name "xDavSynctoken" - field "synctoken"-Member name "xDavColour" - field "colour"-Member name "xDavOrder" - field "order"-Member name "xDavTimeZone" - field "timezone"-Member name "xDavDisplayName" - field "displayname"-Member name "xDavOwnerID" - field "owner"-Member name "xDavFreeBusySet" - field "freeBusySet"-Member name "xDavComponents" - field "components" | ||
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -1 - error, 0 - OK | ||
xDav_UpdateIcs_AddOn
Addon allows to update given term with new data.
| Field | Type | Description |
|---|---|---|
| &updatedIcsData | DBSTRINGSET | string set with new term data |
| &error | STRING | description of the occured error |
| &icsData | DBSTRINGSET | string set with new data |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -3 - object removed, -2 - object not found, -1 - unknown error, 0 - OK | ||
xDav_UpdateVCard_AddOn
AddOn allows to update vCard with new data. These data are passed via string set.
| Field | Type | Description |
|---|---|---|
| &vcard | xDavVCard | vCard that will be updated |
| &error | STRING | description of the occured error |
| &data | DBSTRINGSET | string set with new data |
| String set includes these informations:-Member name "xDavAddressbookID" - field "addressbookId"-Member name "xDavContent" - field "content"-Member name "xDavAvatar" - this is passed via parameter "bigContent"-Member name "xDavIsGroup" - field "isGroup"-Member name "xDavOwnerID" - field "ownerId"-Member name "xDavID" - field "uuid" | ||
| &context | DBSTRINGSET | input parameters that are taken from the request |
| &bigContent | STRING | bigger content tha is passed via BASE64 |
| Return: INT -3 - object deleted, -2 - object not found, -1 - unknown error, 0 - OK | ||
xDav_UuidToIcsData_AddOn
AddOn allows to get the informations of the given term. Informations are returned in string set.
| Field | Type | Description |
|---|---|---|
| &icsData | DBSTRINGSET | string set with the informations of given term |
| String set includes these informations:-Member name "Event UID" - field "uuid"-Member name "Event OID" - field "oid"-Member name "Calendar ID" - field "calendarId"-Member name "Event content" - field "content"-Member name "Last store time" - field"updatedAt" | ||
| &error | STRING | description of the occured error |
| &context | DBSTRINGSET | input parameters that are taken from the request |
| Return: INT -3 - object deleted, -2 - object not found, -1 - unknown error, 0 - OK | ||