From version 2.1
edited by Pierre Dubois
on 2011/10/17 15:26
To version 3.1
edited by Pierre Dubois
on 2012/05/31 15:18
Change comment: Imported from XAR

Summary

Details

Icon Page properties
Content
... ... @@ -1,44 +1,33 @@
1 -A scripted entity
1 +Some utility functions, especially for emails notifications
2 2  
3 -== Functions ==
4 -=== Import(obj) ===
5 5  
6 6  
5 +== Functions ==
7 7  === SUImpersonate() ===
8 -Impoersonate the execution thread as a super user (Admin with all privileges)
7 +Impersonate the execution thread as a super user (Admin with all privileges)
9 9  
10 -=== GetLinkWithHashAuth(obj, actionName, params) ===
11 -
12 -
13 13  === GetLink(obj, actionName, params) ===
14 14  
11 +* obj. The target entity
12 +* actionName. The action to be used. optional. Default value is "get"
13 +* params. Optional parameters
15 15  
16 -=== GetLinkForEMail(obj, strOperationName, strMailSubject, strDestinationAddress) ===
15 +return: A direct link on the target object. (URL link). The object may be any entity.
16 +example:
17 +{{code language="javascript"}}
18 +${Utils.GetLink(assignment, "approve")}
19 +{{/code}}
17 17  
18 -
19 -=== GetRawLinkForEMail(obj, strOperationName, strMailSubject, strDestinationAddress) ===
20 -
21 -
21 +return: The URL as a string
22 22  === ExtractTextFromHTML(txt) ===
23 +Extract the text component for an HTML content
23 23  
24 -
25 -=== GetRawLinkWithHashAuth(obj, actionName, params) ===
26 -
27 -
28 -=== GetRawLink(obj, actionName, params) ===
29 -
30 -
31 -=== AddEventLink(objLinks, objFrom) ===
32 -
33 -
25 +return: the text part
34 34  === GetPropertyTitle(appname, propname) ===
35 35  
36 36  
37 -=== GetPropertyAttribute(appname, propname, attribute) ===
38 -
39 -
40 -=== CompileScript(script) ===
41 -
42 -
43 -=== GetParameterList(params, delim) ===
44 -
29 +return: The property title of a property of an entity
30 +example:
31 +{{code language="javascript"}}
32 +${Utils.getPropertyTitle("rqTimeOffRequest", "rqBeneficiary")}
33 +{{/code}}
This wiki is licensed under a Creative Commons 2.0 license
XWiki Enterprise 9.11.5 - Documentation