CalLock Type
Group of fields used when locking and unlocking a calendar resource.
Remarks
LockType, Owner, Scope Timeout, and Tokens are used when locking and unlocking a calendar resource. You may lock the whole calendar, or only a single event within the calendar, depending on the URI you use when locking. After a successful LockCalendar operation, the class will set all of these properties to the values returned in the server's response. The lock Tokens are then passed along when copying or moving a calendar event.
Fields
|
lockType String |
The type of the current resource lock. Before the calendar resource can be locked, the LockType may be set to the type of lock being requested. Currently, the class only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful LockCalendar operation, the class will set the LockType property to the correct value returned in the server's response. | ||||
|
owner String |
The principle that owns the current resource lock. Before the calendar resource can be locked, the Lock Owner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockCalendar operation, the class will set the Owner property to the correct value returned in the server's response. | ||||
|
scope String |
The scope of the current resource lock. Before the calendar resource can be locked, the Lock Scope may be set to the type of scope needed for the lock. Currently the class will only allow two types of scopes to be requested:
If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful LockCalendar operation, the class will set the Scope property to the correct value returned in the server's response. | ||||
|
timeout Int32 |
The time to live for the current resource lock. Before the calendar resource can be locked, the Lock Timeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If Timeout of 0 is specified, the server will use a default timeout. After a successful LockCalendar operation, the class will set the Lock Timeout property to the correct value returned in the server's response. | ||||
|
tokens String |
The lock string to be used when submitting operations on a locked resource. Before the calendar resource can be locked, the Lock Tokens may be set to the tokens returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in Timeout. If the lock request is not a lock refresh, Tokens must be empty, and will be parsed out of the server response after a successful LockCalendar operation. |
Constructors
public init()