-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathindex.html
More file actions
6 lines (6 loc) · 14.6 KB
/
index.html
File metadata and controls
6 lines (6 loc) · 14.6 KB
1
2
3
4
5
6
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>index | @moosync/moosync-types</title><meta name="description" content="Documentation for @moosync/moosync-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@moosync/moosync-types</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@moosync/moosync-types</a></li><li><a href="index.html">index</a></li></ul><h1>Module index</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.Checkbox.html" class="tsd-kind-icon">Checkbox</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.ExtensionData.html" class="tsd-kind-icon">Extension<wbr/>Data</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.ExtensionFactory.html" class="tsd-kind-icon">Extension<wbr/>Factory</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.MoosyncExtensionTemplate.html" class="tsd-kind-icon">Moosync<wbr/>Extension<wbr/>Template</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.PathGroup.html" class="tsd-kind-icon">Path<wbr/>Group</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.SongAPIOptions.html" class="tsd-kind-icon">SongAPIOptions</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.extensionAPI.html" class="tsd-kind-icon">extensionAPI</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.playerControls.html" class="tsd-kind-icon">player<wbr/>Controls</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="index.html#EntityApiOptions" class="tsd-kind-icon">Entity<wbr/>Api<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="index.html#ExtensionPreferenceGroup" class="tsd-kind-icon">Extension<wbr/>Preference<wbr/>Group</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="index.html#sortOptions" class="tsd-kind-icon">sort<wbr/>Options</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="index.html#EXTENSION_ENTRY_POINT" class="tsd-kind-icon">EXTENSION_<wbr/>ENTRY_<wbr/>POINT</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a name="EntityApiOptions" class="tsd-anchor"></a><h3>Entity<wbr/>Api<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">Entity<wbr/>Api<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>inclusive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">{ </span>album<span class="tsd-signature-symbol">: </span><a href="../interfaces/models.Album.html" class="tsd-signature-type" data-tsd-kind="Interface">Album</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>artist<span class="tsd-signature-symbol">: </span><a href="../interfaces/models.artists.html" class="tsd-signature-type" data-tsd-kind="Interface">artists</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>genre<span class="tsd-signature-symbol">: </span><a href="../interfaces/models.Genre.html" class="tsd-signature-type" data-tsd-kind="Interface">Genre</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>playlist<span class="tsd-signature-symbol">: </span><a href="../interfaces/models.Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/87e92ec/index.d.ts#L165">index.d.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Options for searching entities like Albums, Artists, Playlists or Genre</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a name="ExtensionPreferenceGroup" class="tsd-anchor"></a><h3>Extension<wbr/>Preference<wbr/>Group</h3><div class="tsd-signature tsd-kind-icon">Extension<wbr/>Preference<wbr/>Group<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">{ </span>items<span class="tsd-signature-symbol">: </span><a href="../interfaces/index.Checkbox.html" class="tsd-signature-type" data-tsd-kind="Interface">Checkbox</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"CheckboxGroup"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>default<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"EditText"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>default<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"FilePicker"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>default<span class="tsd-signature-symbol">: </span><a href="../interfaces/index.PathGroup.html" class="tsd-signature-type" data-tsd-kind="Interface">PathGroup</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"DirectoryGroup"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/87e92ec/index.d.ts#L19">index.d.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a name="sortOptions" class="tsd-anchor"></a><h3>sort<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">sort<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>asc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"date"</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/87e92ec/index.d.ts#L107">index.d.ts:107</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sort by name or date.
If asc is true then results will be sorted in ascending otherwise descending</p>
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>asc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"date"</span></h5></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a name="EXTENSION_ENTRY_POINT" class="tsd-anchor"></a><h3>EXTENSION_<wbr/>ENTRY_<wbr/>POINT</h3><div class="tsd-signature tsd-kind-icon">EXTENSION_<wbr/>ENTRY_<wbr/>POINT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"moosync_extension_entry"</span><span class="tsd-signature-symbol"> = 'moosync_extension_entry'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/87e92ec/index.d.ts#L3">index.d.ts:3</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="index.html">index</a></li><li class=" tsd-kind-module"><a href="models.html">models</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.Checkbox.html" class="tsd-kind-icon">Checkbox</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.ExtensionData.html" class="tsd-kind-icon">Extension<wbr/>Data</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.ExtensionFactory.html" class="tsd-kind-icon">Extension<wbr/>Factory</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.MoosyncExtensionTemplate.html" class="tsd-kind-icon">Moosync<wbr/>Extension<wbr/>Template</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.PathGroup.html" class="tsd-kind-icon">Path<wbr/>Group</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.SongAPIOptions.html" class="tsd-kind-icon">SongAPIOptions</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.extensionAPI.html" class="tsd-kind-icon">extensionAPI</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/index.playerControls.html" class="tsd-kind-icon">player<wbr/>Controls</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="index.html#EntityApiOptions" class="tsd-kind-icon">Entity<wbr/>Api<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="index.html#ExtensionPreferenceGroup" class="tsd-kind-icon">Extension<wbr/>Preference<wbr/>Group</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="index.html#sortOptions" class="tsd-kind-icon">sort<wbr/>Options</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="index.html#EXTENSION_ENTRY_POINT" class="tsd-kind-icon">EXTENSION_<wbr/>ENTRY_<wbr/>POINT</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>