Difference between revisions of "Quarantine checkIfQuarantined"
(Created page with "{{Function_Template|Name=Quarantine_checkIfQuarantined|ReturnType=Dictionary |Parameters= |Name=Quarantine Resource Ids|ConstantType=Array, |Name=User Resource Ids|ConstantTyp...") |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | [[Category:Quarantine_Functions]] |
| − | + | {{HelpFiles}} | |
| − | + | ||
| − | + | === Quarantine_checkIfQuarantined === | |
| − | } | + | |
| + | Return a Dictionary which contains keys are User Resource Ids and values. | ||
| + | |||
| + | the value is true if the user is in any quarantine in the quarantines list. | ||
| + | |||
| + | else the value is false. | ||
| + | |||
| + | === Syntax === | ||
| + | |||
| + | Quarantine_checkIfQuarantined(quarantineRIdList, userRIdList); | ||
| + | |||
| + | === Arguments === | ||
| + | |||
| + | quarantineRIdList: Array number Resource Ids of Quarantines. | ||
| + | |||
| + | userRIdList: Array number resource id of users. | ||
| + | |||
| + | === Return type === | ||
| + | |||
| + | Dictionary | ||
| + | |||
| + | === Examples === | ||
| + | |||
| + | <source lang="javascript"> | ||
| + | array userRIdList = {15498958,15517129,15525326,15525327,15525328}; | ||
| + | array quarantineRIdList = {15525523,15525524,15525566}; | ||
| + | Dictionary checkIfQuarantined = Quarantine_checkIfQuarantined(quarantineRIdList, userRIdList); | ||
| + | print(checkIfQuarantined); | ||
| + | |||
| + | // {"15498958": True, "15517129": False, "15525326": True, "15525327": False, "15525328": False} | ||
| + | </source> | ||
Latest revision as of 13:00, 20 May 2016
Quarantine_checkIfQuarantined
Return a Dictionary which contains keys are User Resource Ids and values.
the value is true if the user is in any quarantine in the quarantines list.
else the value is false.
Syntax
Quarantine_checkIfQuarantined(quarantineRIdList, userRIdList);
Arguments
quarantineRIdList: Array number Resource Ids of Quarantines.
userRIdList: Array number resource id of users.
Return type
Dictionary
Examples
array userRIdList = {15498958,15517129,15525326,15525327,15525328};
array quarantineRIdList = {15525523,15525524,15525566};
Dictionary checkIfQuarantined = Quarantine_checkIfQuarantined(quarantineRIdList, userRIdList);
print(checkIfQuarantined);
// {"15498958": True, "15517129": False, "15525326": True, "15525327": False, "15525328": False}
