library.listTokenLibraries: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added new Category tag)
m (Oops, it's "source" that should be replaced with "syntaxhighlight")
Tag: Reverted
Line 17: Line 17:
If the properties don't exist or aren't set, then ''Not Specified'' is returned instead.
If the properties don't exist or aren't set, then ''Not Specified'' is returned instead.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
library.listTokenLibraries()
library.listTokenLibraries()
</source>
</syntaxhighlight >
'''Parameters'''
'''Parameters'''
{{param|None|}}
{{param|None|}}
Line 25: Line 25:
|example=
|example=
List loaded Add-Ons.
List loaded Add-Ons.
<source lang="mtmacro" line>
< syntaxhighlight lang="mtmacro" line>
Token Libraries Loaded:<br>
Token Libraries Loaded:<br>
<pre>[r: json.indent(library.listTokenLibraries(),2)]</pre>
<pre>[r: json.indent(library.listTokenLibraries(),2)]</pre>
</source>
</syntaxhighlight >
Returns:
Returns:
<source lang="JSON">
< syntaxhighlight lang="JSON">
Token Libraries Loaded:
Token Libraries Loaded:
[
[
Line 46: Line 46:
   }
   }
]
]
</source>
</syntaxhighlight >


|also=
|also=

Revision as of 04:21, 11 February 2024

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 (value should be a 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.

< syntaxhighlight lang="mtmacro" line> Token Libraries Loaded:

[r: json.indent(library.listTokenLibraries(),2)]

</syntaxhighlight > Returns: < syntaxhighlight lang="JSON"> 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
 }

]

</syntaxhighlight >

See Also

Version Changes

  • 1.11.0 - Function added