Miscellaneous Function Type
Contents
Function |
Description |
|---|---|
addUserLayout |
Adds a layout that will be used by a user in preference to any standard layouts |
assertActiveUser |
Specifies who the current active user is. |
authenticate |
Authenticates a users password. |
generateUserWorkflowEventURL |
Allows links to be emailed that will cause a UserWorkflowEvent to be run. |
getUserInfo |
Returns whether a user can login, and whether they can receive email. |
logSystemEvent |
Stores a new system event. |
randomDistinct |
Produces a string of random characters of a given length, using only upper case letters or numbers that cannot be mistaken for other letters or numbers. That means we do not use numbers 0 or 1, or letters i, L, O, U or V |
randomURL |
Produces a string of random characters of a given length, using only characters that are suitable for use in a URL. |
sleep |
Pauses execution for a given number of milliseconds. |
warn |
Sends a warning to the workflow user. |
Takes as input the the layouts a user will be given, and all the layouts for a user as returned from a UserLoginWorkflowEvent. Returns nothing.
Can only be used as part of a UserLoginWorkflowEvent, and the function will add a layout to those that the user will see. Layouts assigned here will override any Permissions set up for layouts with reference to this user.
This can be used to specify particular layouts for a user to control the way data is presented.
For example, the existence of some properties may be hidden from some users, rather than only hiding the value of those properties.
Takes as input the currently active user. Returns nothing.
This is useful in situations where the original event is not triggered directly by a user, but the user can be worked out by other means. For example, if there is an anonymous HTTP event triggered from a card reader, and the user can be identified from their card.
If this function is called, then anything created or updated that records who the user is, will use the newly asserted active user.
If the initiating event can identify the active user, then calling this function will not change the active user. Moreover, trying to change the active user, and set a different user from the one the event knows it to be, will be treated as an error.
Takes as input the user Biskit and the password. Returns a boolean.
Takes as input the user event to be triggered, the Biskit that is encoded into the date and a string to be passed into the event that can be used to pass information to the event. Returns a string which is the URL that when accessed will trigger the user workflow event.
Takes as input the user Biskit. Returns a boolean defining whether a user can login and a boolean defining whether they can receive email.
Takes as input the type of the Event, the category for this type of event, the event message and a Biskit to be associated with the event. Returns the system event that was created.
Takes as input the length of the String to be produced. Returns the created String.
Takes as input the length of the String to be produced. Returns the created String.
Takes as input the number of milliseconds to sleep. Returns the initial argument.
Takes as input the message to be sent. Returns whether the warning was delivered.
The workflow must be directly connected to a user's session to be able to do this. So will not work with timed and other types of Events which are not being directly run by a user.