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. |
sequence<string> |
getParamAllowableValues(string paramName)
This function gets a sequence of allowable values for the specified parameter. This can be used by the Position Tracker implementation to inform the user of an enumerated parameter value. |
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. |
string |
getParamType(string paramName)
This function returns the type of the configuration parameter as a string (e.g. "string", "boolean", "integer", "float", etc). |
boolean |
hasParam(string paramName)
This function allows the user to check whether the Position Tracker implementation 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 by the client on subscription. |
boolean |
isParamRequired(string paramName)
This function returns whether the parameter is required to be passed back to the Position Tracker implementation on subscription, 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.
sequence<string> getParamAllowableValues(string paramName)This function gets a sequence of allowable values for the specified parameter. This can be used by the Position Tracker implementation to inform the user of an enumerated parameter value.
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.
string getParamType(string paramName)This function returns the type of the configuration parameter as a string (e.g. "string", "boolean", "integer", "float", etc).
boolean hasParam(string paramName)This function allows the user to check whether the Position Tracker implementation 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 by the client on subscription.
boolean isParamRequired(string paramName)This function returns whether the parameter is required to be passed back to the Position Tracker implementation on subscription, or whether the parameter is optional.
FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |