FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |
Action summary | |
---|---|
void |
addItem(string name, string type, string defaultValue, sequence<string> allowableValues, string description, boolean required, boolean referenceOnly)
This function adds a new configuration parameter to the list with the full set of information. |
void |
addItemMinimal(string name, string type, string defaultValue, string description)
This function adds a new configuration parameter to the list with the full set of information. |
void |
clear()
This function clears any current Schema Items from this event. |
sequence<string> |
getParamAllowableValues(string paramName)
This function gets a sequence of allowable values for the specified parameter. |
string |
getParamDefaultValue(string paramName)
This function gets the default value for the specified parameter (as a string). |
string |
getParamDescription(string paramName)
This function gets the description of the specified parameter. |
dictionary<string, string> |
getParamsAndTypes()
This function returns a list of all the parameters and their types as dictionary. |
string |
getParamType(string paramName)
This function gets the type of parameter as a string (e.g. "string", "boolean", "integer", "float", etc). |
boolean |
hasParam(string paramName)
This function allows the user to check whether the schema supports the specified parameter name. |
boolean |
isParamReferenceOnly(string paramName)
This function returns whether the parameter is for reference purposes only or whether the parameter is configurable. |
boolean |
isParamRequired(string paramName)
This function returns whether the parameter is required, or whether the parameter is optional. |
Action detail |
---|
void addItem(string name, string type, string defaultValue, sequence<string> allowableValues, string description, boolean required, boolean referenceOnly)This function adds a new configuration parameter to the list with the full set of information.
void addItemMinimal(string name, string type, string defaultValue, string description)This function adds a new configuration parameter to the list with the full set of information.
void clear()This function clears any current Schema Items from this event.
sequence<string> getParamAllowableValues(string paramName)This function gets a sequence of allowable values for the specified parameter.
string getParamDefaultValue(string paramName)This function gets the default value for the specified parameter (as a string).
string getParamDescription(string paramName)This function gets the description of the specified parameter.
dictionary<string, string> getParamsAndTypes()This function returns a list of all the parameters and their types as dictionary.
string getParamType(string paramName)This function gets the type of parameter as a string (e.g. "string", "boolean", "integer", "float", etc).
boolean hasParam(string paramName)This function allows the user to check whether the schema supports the specified parameter name.
boolean isParamReferenceOnly(string paramName)This function returns whether the parameter is for reference purposes only or whether the parameter is configurable.
boolean isParamRequired(string paramName)This function returns whether the parameter is required, or whether the parameter is optional.
FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |