Adds the specifed user to the folder subscription list

Syntax

Visual Basic (declaration)
Public Function AddUserToFolderSubscribers( _ 
ByVal AuthenticationTicket as String, _ ByVal FolderPath as String, _ ByVal UserName as String, _ ByVal ON_READ as bool, _ ByVal ON_CHANGE as bool, _ ByVal ON_UPDATE as bool, _ ByVal ON_CHECKOUT as bool, _ ByVal ON_APPROVE as bool, _ ByVal ON_REJECT as bool, _ ByVal ON_COMMENT as bool, _ ByVal ON_MOVE as bool, _ ByVal ON_DELETE as bool, _ ByVal ON_CHECKIN as bool, _ ByVal ON_NEWDOC as bool, _ ByVal IncludeSubObjects as bool) as XmlNode

C# (declaration)
public XmlNode AddUserToFolderSubscribers( 
string AuthenticationTicket, string FolderPath, string UserName, bool ON_READ, bool ON_CHANGE, bool ON_UPDATE, bool ON_CHECKOUT, bool ON_APPROVE, bool ON_REJECT, bool ON_COMMENT, bool ON_MOVE, bool ON_DELETE, bool ON_CHECKIN, bool ON_NEWDOC, bool IncludeSubObjects)

Parameters

AuthenticationTicket
    string infoRouter ticket
FolderPath
    string Folder path that the subsriber to be added.
UserName
    string The username of the user.
ON_READ
    bool Read event subscription (open/download)
ON_CHANGE
    bool Content change event subscription
ON_UPDATE
    bool Meta data or property update event subscription
ON_CHECKOUT
    bool checked-out event subscription
ON_APPROVE
    bool approve event subscription
ON_REJECT
    bool reject event subscription
ON_COMMENT
    bool Add Comment event subscription
ON_MOVE
    bool Move event subscription
ON_DELETE
    bool Delete event subscription
ON_CHECKIN
    bool Check-in event subscription
ON_NEWDOC
    bool New document event subscription
IncludeSubObjects
    bool Subcribe to the sub-folders and the documents

Return Value

returns xml fragment.
<response success="true" error="">
if success attribute is "true", the subscriber has been added.
if success attribute is "false", the error attribute indicates the encountered error.

Remarks

If the caller subscribe to the folder him/her self no permission is required.
Otherwise the caller must have "full control" to the document.