Define and enumeration object. An enumeration is a collection of text identifiers with an integer value. This tag should contain <value> tags that define the values.
You can retrieve an enumeration object with the <get-enum> tag.
<enum libname="enum.jsonrpc.errors"><value id="1" name="not_logged_in" description="You must be logged in to do that" /><value name="invalid_score" description="Score must be -1, 0 or +1"/><value name="unknown_link" description="Link object was not found"/></enum>
name | purpose | type | required? | default | choices |
---|---|---|---|---|---|
name |
Identifier for enum | text | No | ||
start |
Starting ID if not specified in <value> | integer | No | 1 |