lock-caldav-object.h File Reference

#include "caldav-utils.h"
#include "caldav.h"

Functions
gchar *	caldav_lock_object (gchar *URI, caldav_settings *settings, caldav_error *error)
	Function which requests a lock on a calendar resource.
gboolean	caldav_unlock_object (gchar *lock_token, gchar *URI, caldav_settings *settings, caldav_error *error)
	Function which requests to have a lock removed from a calendar resource.
gboolean	caldav_lock_support (caldav_settings *settings, caldav_error *error)
	Function to test whether the server supports locking or not.

---

Function Documentation

gchar* caldav_lock_object	(	gchar *	URI,
		caldav_settings *	settings,
		caldav_error *	error
	)

Function which requests a lock on a calendar resource.

Parameters:

	URI	The resource to request lock on.
	settings

See also:

caldav_settings

Parameters:

error

A pointer to caldav_error.

See also:

caldav_error

Returns:

The Lock-Token or NULL in case of error

gboolean caldav_lock_support	(	caldav_settings *	settings,
		caldav_error *	error
	)

Function to test whether the server supports locking or not.

Parameters:

settings

See also:

caldav_settings

Parameters:

error

A pointer to caldav_error.

See also:

caldav_error

Returns:

True if locking is supported by the server. False otherwise

Searching for PROP LOCK. If LOCK is present then according to RFC4791 PROP UNLOCK must also be present.

Parameters:

settings

See also:

caldav_settings

Parameters:

error

A pointer to caldav_error.

See also:

caldav_error

Returns:

True if locking is supported by the server. False otherwise

gboolean caldav_unlock_object	(	gchar *	lock_token,
		gchar *	URI,
		caldav_settings *	settings,
		caldav_error *	error
	)

Function which requests to have a lock removed from a calendar resource.

Parameters:

	lock_token	A privious aquired Lock-Token
	URI	The resource to request unlock on.
	settings

See also:

caldav_settings

Parameters:

error

A pointer to caldav_error.

See also:

caldav_error

Returns:

False in case the lock could not be removed. True otherwise.