Plumtree EDK (Enterprise Web Development Kit) 5.4.0

IProjectManager.SubscribeUsers Method 

Subscribes users of the given IDs to a project, with an option of whether the users being subscribed will get notified for all new object creations in that project.

void SubscribeUsers(
   IProject project,
   int[] userIDs,
   bool notifyForAllCreation
);

Parameters

project
The project to subscribe users to; cannot be null.
userIDs
The IDs of the users to subscribe to the project; cannot be null; all IDs must be positive.
notifyForAllCreation
true if the given users to be subscribed will get notified upon all new object creations in the project; false if the users will only get notified once upon being subscribed. Notification server has to be enabled for this to take effect.

Remarks

To subscribe users to a specific object in a project, use the SubscribeUsers method in other object manager interfaces.

The calling user must have admin access to the project, and the users to be subscribed have to have at least READ access to the project. The call will make a best attempt to subscribe all supplied, valid users. A MultipleObjectException will be thrown specifying the IDs that failed to be subscribed.

Exceptions

Exception TypeCondition
InvalidOperationException if the project has not yet been stored or has already been removed.
ArgumentException Any of the userIDs is not > 0.
MultipleObjectException Any users cannot be subscribed
CollaborationException The method call resulted in an error.
SoapException if there is a communication problem during the execution of the remote method call.

See Also

IProjectManager Interface | Plumtree.Remote.PRC.Collaboration.Project Namespace