library.listTokenLibraries

From RPTools Wiki
Revision as of 14:52, 20 October 2021 by Phergus (talk | contribs) (Created page with "{{MacroFunction |name=library.listTokenLibraries |proposed=true |trusted=false |version=1.11.0 |description= List available Lib:Token add-on libraries. I...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

library.listTokenLibraries() Function

Introduced in version 1.11.0
List available Lib:Token add-on libraries. Information is returned as an array of JSON objects. Information returned comes from the following Token properties:
  • libVersion
  • libAuthors (comma separated list if there is more than one)
  • libWebsite
  • libGitUrl
  • libLicense
  • libDescription
  • libShortDescription
If the properties don't exist or aren't set then Not Specified is returned instead.

Usage

library.listTokenLibraries()

Parameters

  • None -

Example

List loaded Add-Ons.
Token Libraries Loaded:<br>
<pre>[r: json.indent(library.listTokenLibraries(),2)]</pre>

Returns:

Token Libraries Loaded:
[
  {
    "name": "lib:mytoken",
    "namespace": "mytoken",
    "version": "0.1",
    "website": "www.google.com",
    "gitUrl": "none.github.com",
    "authors": ["Turing"],
    "license": "None",
    "description": "Long Description",
    "shortDescription": "Short Desc.",
    "allowsUrlAccess": true
  }
]

See Also

Version Changes

  • 1.11.0 - Function added