Click or drag to resize

IHierarchyItemAsyncSetCommentAndAuthorAsync Method (String, String)

IT Hit WebDAV Classes Reference
Updates comment and author information.

Namespace:  ITHit.WebDAV.Client
Assembly:  ITHit.WebDAV.Client (in ITHit.WebDAV.Client.dll) Version: 2.0.420.0
Syntax
Copy
Task SetCommentAndAuthorAsync(
	string comment,
	string author
)

Parameters

comment
Type: SystemString
Comment about an item that is suitable for presentation to a user.
author
Type: SystemString
Description of the creator of the item.

Return Value

Type: Task

[Missing <returns> documentation for "M:ITHit.WebDAV.Client.IHierarchyItemAsync.SetCommentAndAuthorAsync(System.String,System.String)"]

Exceptions
ExceptionCondition
UnauthorizedExceptionRequest is not authorized.
LockedException The specified resource or folder is locked and the client either is not a lock owner or the lock type requires a lock token to be submitted and the client did not submit it.
LockedExceptionThis item is locked and no lock token was specified.
ConflictExceptionThe item is version controlled and has to be checked out to be edited.
NotFoundExceptionThis item doesn't exist on the server.
WebDavHttpExceptionServer returned unknown error.
WebDavExceptionIn case of any unexpected error.
Examples
The following example demonstrates how to lock item, check-out, update, check-in, unlock and set comment and author for a version.
Copy
string license = "<?xml version='1.0' encoding='utf...
WebDavSessionAsync session = new WebDavSessionAsync(license);
session.Credentials = new NetworkCredential("User1", "pwd");

IFileAsync file = await session.OpenFileAsync(new Uri("http://server/directory/file.docx"));
LockInfo lockInfo = await file.LockAsync(LockScope.Exclusive, false, "John Walter", TimeSpan.MaxValue);
await file.CheckOutAsync(lockInfo.LockToken.LockToken);
await file.UpdatePropertiesAsync(
    new Property[] {new Property(new PropertyName("amount", "server"), "2")}, null,
    lockInfo.LockToken.LockToken);
IVersionAsync version = await file.CheckInAsync(lockInfo.LockToken.LockToken);
await file.UnlockAsync(lockInfo.LockToken.LockToken);
await version.SetCommentAndAuthorAsync("Fixed some bugs.", "John");
See Also