Members
-
EvalScript_ErrMessage
-
EvalScript error message
- Source:
-
VulcanInterface
-
Singleton instance of Vulcan
Methods
-
AgoraLibResponse(string, string, int)
-
Returned as the response by all AgoraLib APIs.
Parameters:
Name Type Description string
response The main result of the API request
string
status Textual description that either provides information of an error or additional information about the response.
int
statusCode status code.
- Source:
-
CSXSWindowType()
-
Stores constants for the window types supported by the CSXS infrastructure.
- Source:
-
GetValueByKey(xmlStr, key)
-
Retrieves the content of an XML element.
Parameters:
Name Type Description xmlStr
The XML string.
key
The name of the tag.
Returns:
The content of the tag, or the empty string
if such tag is not found or the tag has no content. -
requiredParamsValid()
-
Reports whether required parameters are valid.
Returns:
True if all required parameters are valid,
false if any of the required parameters are invalid. -
strStartsWith(str, prefix)
-
Reports whether a string has a given prefix.
Parameters:
Name Type Description str
The target string.
prefix
The specific prefix string.
Returns:
True if the string has the prefix, false if not.
Type Definitions
-
ErrorCode
-
The value of the "err" property returned from CEP functions
Possible error codes and their corresponding meanings:
- 0 - NO_ERROR
- 1 - ERR_UNKNOWN
- 2 - ERR_INVALID_PARAMS
- 3 - ERR_NOT_FOUND
- 4 - ERR_CANT_READ
- 5 - ERR_UNSUPPORTED_ENCODING
- 6 - ERR_CANT_WRITE
- 7 - ERR_OUT_OF_SPACE
- 8 - ERR_NOT_FILE
- 9 - ERR_NOT_DIRECTORY
- 10 - ERR_FILE_EXISTS
- 101 - ERR_EXCEED_MAX_NUM_PROCESS
- 201 - ERR_INVALID_URL
- 202 - DEPRECATED_API
Type:
- number
- Source:
-
JSON_String
-
Type:
- object
- Source:
Properties:
Name Type Description keyCode
number Required, represents an OS system dependent virtual key code identifying the unmodified value of the pressed key.
ctrlKey
boolean [optional] a Boolean that indicates if the control key was pressed (true) or not (false) when the event occurred.
altKey
boolean [optional] a Boolean that indicates if the alt key was pressed (true) or not (false) when the event occurred.
shiftKey
boolean [optional] a Boolean that indicates if the shift key was pressed (true) or not (false) when the event occurred.
metaKey
boolean [optional] (Mac Only) a Boolean that indicates if the Meta key was pressed (true) or not (false) when the event occurred. On Macintosh keyboards, this is the command key. To detect Windows key on Windows, please use keyCode instead.