library.listTokenLibraries: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Turn off 'proposed')
m (Added new Category tag)
Line 7: Line 7:
List available [[Library Token|Lib:Token]] add-on libraries. Information is returned as an array of JSON objects. Information returned comes from the following Token properties:
List available [[Library Token|Lib:Token]] add-on libraries. Information is returned as an array of JSON objects. Information returned comes from the following Token properties:


* libVersion
* {{code|libVersion}}
* libAuthors  (comma separated list if there is more than one)
* {{code|libAuthors}}   (value should be a comma separated list if there is more than one)
* libWebsite
* {{code|libWebsite}}
* libGitUrl
* {{code|libGitUrl}}
* libLicense
* {{code|libLicense}}
* libDescription
* {{code|libDescription}}
* libShortDescription
* {{code|libShortDescription}}
 
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=
<syntaxhighlight lang="mtmacro" line>
<source lang="mtmacro" line>
library.listTokenLibraries()
library.listTokenLibraries()
</syntaxhighlight>
</source>
'''Parameters'''
'''Parameters'''
{{param|None|}}
{{param|None|}}
Line 26: Line 25:
|example=
|example=
List loaded Add-Ons.
List loaded Add-Ons.
<syntaxhighlight lang="mtmacro" line>
<source 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>
</syntaxhighlight>
</source>
Returns:
Returns:
<syntaxhighlight lang="JSON">
<source lang="JSON">
Token Libraries Loaded:
Token Libraries Loaded:
[
[
Line 47: Line 46:
   }
   }
]
]
</syntaxhighlight>
</source>


|also=
|also=
Line 56: Line 55:
}}
}}
[[Category:Library Function]]
[[Category:Library Function]]
[[Category:Add-on Library Functions]]

Revision as of 03:37, 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.
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