1. Home / Web Services API Version 7.5 / AddUserToDocumentSubscribers

AddUserToDocumentSubscribers

Adds the specifed user to the document subscription list

Syntax

Visual Basic (declaration) 
Public Function AddUserToDocumentSubscribers( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal DocumentPath 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) as XmlNode

C# (declaration) 
public XmlNode AddUserToDocumentSubscribers( 
	string AuthenticationTicket,
	string DocumentPath,
	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)

Parameters

AuthenticationTicket
    string infoRouter ticket
DocumentPath
    string Document path that the subscriber 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

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 document him/her self no permission is required.
Otherwise the caller must have "full control" to the document.

See Also