Difference between revisions of "Quarantine addToQuarantine"

From Catglobe Wiki
Jump to: navigation, search
Line 28: Line 28:
 
string comment = "quarantine for test";
 
string comment = "quarantine for test";
 
Quarantine_addToQuarantine(quarantineRId, userRIdList, comment);
 
Quarantine_addToQuarantine(quarantineRId, userRIdList, comment);
 
+
</source>
</source><br/><source lang="javascript">
+
<br/><source lang="javascript">
 
setRPQId(1742872963);//rpq on qnire name "An test - in/ex from"
 
setRPQId(1742872963);//rpq on qnire name "An test - in/ex from"
 
number quarantineRId = 15549081;
 
number quarantineRId = 15549081;
Line 35: Line 35:
 
//result: Add current user (logged in user) to the quarantine with comment is qnaire displayname (name on "Alias" field).  
 
//result: Add current user (logged in user) to the quarantine with comment is qnaire displayname (name on "Alias" field).  
 
//If the qnaire lacking displayname will show resourcename (name on "Questionnaire name" field)
 
//If the qnaire lacking displayname will show resourcename (name on "Questionnaire name" field)
 
+
</source>
 +
<source lang="javascript">
 +
setRPQId(1742872963);//rpq on qnire name "An test - in/ex from"
 +
number quarantineRId = 15549081;
 +
array arrayUserRId={14618942,14620060};
 +
Quarantine_addToQuarantine(quarantineRId,arrayUserRId);
 +
//result: Add uers in the user array to the quarantine with comment is qnaire displayname (name on "Alias" field).
 +
//If the qnaire lacking displayname will show resourcename (name on "Questionnaire name" field)
 
</source>
 
</source>
 
[[Category:Quarantine_Functions]]
 
[[Category:Quarantine_Functions]]

Revision as of 05:03, 30 November 2016


Quarantine_addToQuarantine

Specified users are added to that quarantine.

Syntax

Quarantine_addToQuarantine(quarantineRId, userRIdList,Comment);

Arguments

quarantineRId: is a number expression. It is the quarantine's resource id.

userRIdList: Array number resource id of users.

Comment: is a string expression. It must be between 10 and 250 char long. It is contents of comment property of quarantine, you can see it at quarantine history tab of users.

Return type

Empty

Examples

number quarantineRId = 15525774;
array userRIdList = {15498958,15517129,15525326,15525327,15525328};
string comment = "quarantine for test";
Quarantine_addToQuarantine(quarantineRId, userRIdList, comment);


setRPQId(1742872963);//rpq on qnire name "An test - in/ex from"
number quarantineRId = 15549081;
Quarantine_addToQuarantine(quarantineRId);
//result: Add current user (logged in user) to the quarantine with comment is qnaire displayname (name on "Alias" field). 
//If the qnaire lacking displayname will show resourcename (name on "Questionnaire name" field)
setRPQId(1742872963);//rpq on qnire name "An test - in/ex from"
number quarantineRId = 15549081;
array arrayUserRId={14618942,14620060};
Quarantine_addToQuarantine(quarantineRId,arrayUserRId);
//result: Add uers in the user array to the quarantine with comment is qnaire displayname (name on "Alias" field). 
//If the qnaire lacking displayname will show resourcename (name on "Questionnaire name" field)