-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathextensionAPI.html
More file actions
216 lines (216 loc) · 169 KB
/
Copy pathextensionAPI.html
File metadata and controls
216 lines (216 loc) · 169 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>extensionAPI | @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="extensionAPI.html">extensionAPI</a></li></ul><h1>Interface extensionAPI</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">extensionAPI</span></li></ul></section><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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="extensionAPI.html#player" class="tsd-kind-icon">player</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="extensionAPI.html#utils" class="tsd-kind-icon">utils</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#addPlaylist" class="tsd-kind-icon">add<wbr/>Playlist</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#addSongs" class="tsd-kind-icon">add<wbr/>Songs</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#addSongsToPlaylist" class="tsd-kind-icon">add<wbr/>Songs<wbr/>To<wbr/>Playlist</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#addUserPreference" class="tsd-kind-icon">add<wbr/>User<wbr/>Preference</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#changeAccountAuthStatus" class="tsd-kind-icon">change<wbr/>Account<wbr/>Auth<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#closeLoginModal" class="tsd-kind-icon">close<wbr/>Login<wbr/>Modal</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getContextMenuItems" class="tsd-kind-icon">get<wbr/>Context<wbr/>Menu<wbr/>Items</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getCurrentSong" class="tsd-kind-icon">get<wbr/>Current<wbr/>Song</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#getEntity" class="tsd-kind-icon">get<wbr/>Entity</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getInstalledExtensions" class="tsd-kind-icon">get<wbr/>Installed<wbr/>Extensions</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getPlayerState" class="tsd-kind-icon">get<wbr/>Player<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#getPreferences" class="tsd-kind-icon">get<wbr/>Preferences</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getQueue" class="tsd-kind-icon">get<wbr/>Queue</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#getSecure" class="tsd-kind-icon">get<wbr/>Secure</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getSongs" class="tsd-kind-icon">get<wbr/>Songs</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getTime" class="tsd-kind-icon">get<wbr/>Time</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getVolume" class="tsd-kind-icon">get<wbr/>Volume</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#openExternalURL" class="tsd-kind-icon">open<wbr/>ExternalURL</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#openLoginModal" class="tsd-kind-icon">open<wbr/>Login<wbr/>Modal</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#registerAccount" class="tsd-kind-icon">register<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#registerOAuth" class="tsd-kind-icon">registerOAuth</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#removeContextMenuItem" class="tsd-kind-icon">remove<wbr/>Context<wbr/>Menu<wbr/>Item</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#removeSong" class="tsd-kind-icon">remove<wbr/>Song</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#removeUserPreference" class="tsd-kind-icon">remove<wbr/>User<wbr/>Preference</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#setAlbumEditableInfo" class="tsd-kind-icon">set<wbr/>Album<wbr/>Editable<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#setArtistEditableInfo" class="tsd-kind-icon">set<wbr/>Artist<wbr/>Editable<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#setContextMenuItem" class="tsd-kind-icon">set<wbr/>Context<wbr/>Menu<wbr/>Item</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#setPreferences" class="tsd-kind-icon">set<wbr/>Preferences</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#setSecure" class="tsd-kind-icon">set<wbr/>Secure</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#showToast" class="tsd-kind-icon">show<wbr/>Toast</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#updateSong" class="tsd-kind-icon">update<wbr/>Song</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="player" class="tsd-anchor"></a><h3>player</h3><div class="tsd-signature tsd-kind-icon">player<span class="tsd-signature-symbol">:</span> <a href="playerControls.html" class="tsd-signature-type" data-tsd-kind="Interface">playerControls</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L1001">index.d.ts:1001</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Object containing controls for player</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="utils" class="tsd-anchor"></a><h3>utils</h3><div class="tsd-signature tsd-kind-icon">utils<span class="tsd-signature-symbol">:</span> <a href="utils.html" class="tsd-signature-type" data-tsd-kind="Interface">utils</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L592">index.d.ts:592</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="addPlaylist" class="tsd-anchor"></a><h3>add<wbr/>Playlist</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Playlist<span class="tsd-signature-symbol">(</span>playlist<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"playlist_id"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L692">index.d.ts:692</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Add playlist to library</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>playlist: <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"playlist_id"</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>details of playlist which is to be added to library</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div><p>ID of playlist which has been added</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="addSongs" class="tsd-anchor"></a><h3>add<wbr/>Songs</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Songs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>songs<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L666">index.d.ts:666</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Add songs to library</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>songs: <a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>1 or more songs that are to be added to library</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>array of booleans with same index as song. True means song has been added successfully</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="addSongsToPlaylist" class="tsd-anchor"></a><h3>add<wbr/>Songs<wbr/>To<wbr/>Playlist</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Songs<wbr/>To<wbr/>Playlist<span class="tsd-signature-symbol">(</span>playlistID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>songs<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L699">index.d.ts:699</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Add songs to playlist in library. The song must also exist in the library</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>playlistID: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>ID of playlist in which songs are to be added</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>songs: <a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Songs which are to be added in the playlist</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="addUserPreference" class="tsd-anchor"></a><h3>add<wbr/>User<wbr/>Preference</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>User<wbr/>Preference<span class="tsd-signature-symbol">(</span>pref<span class="tsd-signature-symbol">: </span><a href="../modules.html#ExtensionPreferenceGroup" class="tsd-signature-type" data-tsd-kind="Type alias">ExtensionPreferenceGroup</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L995">index.d.ts:995</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>pref: <a href="../modules.html#ExtensionPreferenceGroup" class="tsd-signature-type" data-tsd-kind="Type alias">ExtensionPreferenceGroup</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="changeAccountAuthStatus" class="tsd-anchor"></a><h3>change<wbr/>Account<wbr/>Auth<wbr/>Status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">change<wbr/>Account<wbr/>Auth<wbr/>Status<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, loggedIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, username<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L950">index.d.ts:950</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Change login status and signed in user's account name.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>accountId to change details of. Returned from <a href="extensionAPI.html#registerAccount">registerAccount</a></p>
</div></div></li><li><h5>loggedIn: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>true if user is logged in otherwise false</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> username: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="closeLoginModal" class="tsd-anchor"></a><h3>close<wbr/>Login<wbr/>Modal</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">close<wbr/>Login<wbr/>Modal<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L966">index.d.ts:966</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Close login modal if its open</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getContextMenuItems" class="tsd-anchor"></a><h3>get<wbr/>Context<wbr/>Menu<wbr/>Items</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Context<wbr/>Menu<wbr/>Items<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#ExtensionContextMenuItem" class="tsd-signature-type" data-tsd-kind="Type alias">ExtensionContextMenuItem</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#ContextMenuTypes" class="tsd-signature-type" data-tsd-kind="Type alias">ContextMenuTypes</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L921">index.d.ts:921</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get all registered context menu items</p>
</div></div><h4 class="tsd-returns-title">Returns <a href="../modules.html#ExtensionContextMenuItem" class="tsd-signature-type" data-tsd-kind="Type alias">ExtensionContextMenuItem</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#ContextMenuTypes" class="tsd-signature-type" data-tsd-kind="Type alias">ContextMenuTypes</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getCurrentSong" class="tsd-anchor"></a><h3>get<wbr/>Current<wbr/>Song</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Current<wbr/>Song<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L609">index.d.ts:609</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the current playing track. Undefined if no track is playing</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a name="getEntity" class="tsd-anchor"></a><h3>get<wbr/>Entity</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<wbr/>Entity<T><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules.html#EntityApiOptions" class="tsd-signature-type" data-tsd-kind="Type alias">EntityApiOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L604">index.d.ts:604</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get entities such as playlists, artists, albums, genres from database by provided options</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="Album.html" class="tsd-signature-type" data-tsd-kind="Interface">Album</a><span class="tsd-signature-symbol"> | </span><a href="Artists.html" class="tsd-signature-type" data-tsd-kind="Interface">Artists</a><span class="tsd-signature-symbol"> | </span><a href="Genre.html" class="tsd-signature-type" data-tsd-kind="Interface">Genre</a><span class="tsd-signature-symbol"> | </span><a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../modules.html#EntityApiOptions" class="tsd-signature-type" data-tsd-kind="Type alias">EntityApiOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>filter the results</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getInstalledExtensions" class="tsd-anchor"></a><h3>get<wbr/>Installed<wbr/>Extensions</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Installed<wbr/>Extensions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L993">index.d.ts:993</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns a list of package names of all installed extensions</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getPlayerState" class="tsd-anchor"></a><h3>get<wbr/>Player<wbr/>State</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Player<wbr/>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#PlayerState" class="tsd-signature-type" data-tsd-kind="Type alias">PlayerState</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L614">index.d.ts:614</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get state of music player. Undefined is player is broken and audio can't be loaded</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#PlayerState" class="tsd-signature-type" data-tsd-kind="Type alias">PlayerState</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a name="getPreferences" class="tsd-anchor"></a><h3>get<wbr/>Preferences</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<wbr/>Preferences<T><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, defaultValue<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L638">index.d.ts:638</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Fetch preferences by key. If no key is provided, all preferences
co-relating to current extension will be fetched.</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> key: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>key of preference to fetch. keys within complex objects can be separated by .</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> defaultValue: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If the provided key is not found, then default value will be returned.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getQueue" class="tsd-anchor"></a><h3>get<wbr/>Queue</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Queue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="SongQueue.html" class="tsd-signature-type" data-tsd-kind="Interface">SongQueue</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L629">index.d.ts:629</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the queue of tracks</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="SongQueue.html" class="tsd-signature-type" data-tsd-kind="Interface">SongQueue</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a name="getSecure" class="tsd-anchor"></a><h3>get<wbr/>Secure</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<wbr/>Secure<T><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, defaultValue<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L652">index.d.ts:652</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get decrypted value of an encrypted preference</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>key of preference to fetch. keys within complex objects can be separated by .</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> defaultValue: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If the provided key is not found, then default value will be returned.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getSongs" class="tsd-anchor"></a><h3>get<wbr/>Songs</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Songs<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="SongAPIOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SongAPIOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L598">index.d.ts:598</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get songs from database filtered by provided options</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="SongAPIOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SongAPIOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>filter the results</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getTime" class="tsd-anchor"></a><h3>get<wbr/>Time</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Time<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L624">index.d.ts:624</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get current time of the player.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getVolume" class="tsd-anchor"></a><h3>get<wbr/>Volume</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Volume<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L619">index.d.ts:619</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get volume directly from the audio player</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a name="off" class="tsd-anchor"></a><h3>off</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">off<T><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L904">index.d.ts:904</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Remove callbacks from extra events</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ExtraExtensionEventTypes" class="tsd-signature-type" data-tsd-kind="Type alias">ExtraExtensionEventTypes</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>name of event whose callback is to be removed</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedPlaylists"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>invalidateCache<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaylistReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaylistReturnType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedPlaylistSongs"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>playlistID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, invalidateCache<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, nextPageToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedPlaylistSongs"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"oauthCallback"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"songQueueChanged"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>songQueue<span class="tsd-signature-symbol">: </span><a href="SongQueue.html" class="tsd-signature-type" data-tsd-kind="Interface">SongQueue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"seeked"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>newTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"volumeChanged"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>newVolume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"playerStateChanged"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>newState<span class="tsd-signature-symbol">: </span><a href="../modules.html#PlayerState" class="tsd-signature-type" data-tsd-kind="Type alias">PlayerState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"songChanged"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"preferenceChanged"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>preference<span class="tsd-signature-symbol">: </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>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"playbackDetailsRequested"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaybackDetailsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaybackDetailsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"playbackDetailsRequested"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"customRequest"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#CustomRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">CustomRequestReturnType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedSongFromURL"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSongFromURL"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedPlaylistFromURL"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaylistAndSongsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaylistAndSongsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedPlaylistFromURL"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedSearchResult"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>term<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SearchReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SearchReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSearchResult"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedRecommendations"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#RecommendationsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">RecommendationsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedRecommendations"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedLyrics"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedLyrics"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedArtistSongs"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>artist<span class="tsd-signature-symbol">: </span><a href="Artists.html" class="tsd-signature-type" data-tsd-kind="Interface">Artists</a>, nextPageToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedArtistSongs"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedAlbumSongs"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>album<span class="tsd-signature-symbol">: </span><a href="Album.html" class="tsd-signature-type" data-tsd-kind="Interface">Album</a>, nextPageToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedAlbumSongs"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"requestedSongFromId"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSongFromId"</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><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"songAdded"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>songs<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"songRemoved"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>songs<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"playlistAdded"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>playlist<span class="tsd-signature-symbol">: </span><a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"playlistRemoved"</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>songs<span class="tsd-signature-symbol">: </span><a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L719">index.d.ts:719</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when playlists are requested by the user
The callback should return and result playlists or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedPlaylists"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>invalidateCache<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaylistReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaylistReturnType</a><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>invalidateCache<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaylistReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaylistReturnType</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>invalidateCache: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaylistReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaylistReturnType</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L725">index.d.ts:725</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when songs of a single playlist are requested by the user
The callback should return result songs or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedPlaylistSongs"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>playlistID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, invalidateCache<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, nextPageToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedPlaylistSongs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>playlistID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, invalidateCache<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, nextPageToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedPlaylistSongs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>playlistID: <span class="tsd-signature-type">string</span></h5></li><li><h5>invalidateCache: <span class="tsd-signature-type">boolean</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> nextPageToken: <span class="tsd-signature-type">unknown</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedPlaylistSongs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L738">index.d.ts:738</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when moosync is passed url containing registered oauth channel name
Oauth channel should be registered using <a href="extensionAPI.html#registerOAuth">registerOAuth</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"oauthCallback"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L743">index.d.ts:743</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when song queue changes order or new song is added or removed</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"songQueueChanged"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>songQueue<span class="tsd-signature-symbol">: </span><a href="SongQueue.html" class="tsd-signature-type" data-tsd-kind="Interface">SongQueue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>songQueue<span class="tsd-signature-symbol">: </span><a href="SongQueue.html" class="tsd-signature-type" data-tsd-kind="Interface">SongQueue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>songQueue: <a href="SongQueue.html" class="tsd-signature-type" data-tsd-kind="Interface">SongQueue</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L748">index.d.ts:748</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when user seeks player manually</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"seeked"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>newTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>newTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>newTime: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L753">index.d.ts:753</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when user changes volume</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"volumeChanged"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>newVolume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>newVolume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>newVolume: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L758">index.d.ts:758</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when player changes state to / from paused, stopped, playing, loading</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"playerStateChanged"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>newState<span class="tsd-signature-symbol">: </span><a href="../modules.html#PlayerState" class="tsd-signature-type" data-tsd-kind="Type alias">PlayerState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>newState<span class="tsd-signature-symbol">: </span><a href="../modules.html#PlayerState" class="tsd-signature-type" data-tsd-kind="Type alias">PlayerState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>newState: <a href="../modules.html#PlayerState" class="tsd-signature-type" data-tsd-kind="Type alias">PlayerState</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L763">index.d.ts:763</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when new song is loaded into player</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"songChanged"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>song: <a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L768">index.d.ts:768</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when preferences corresponding to the extension are changed</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"preferenceChanged"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>preference<span class="tsd-signature-symbol">: </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>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>preference<span class="tsd-signature-symbol">: </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>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>preference: <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>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L776">index.d.ts:776</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when song provided by the extension lacks <a href="Song.html#playbackUrl">Song.playbackUrl</a> or <a href="Song.html#duration">Song.duration</a>
Callback should return both playbackUrl and duration even if only either is missing or undefined.</p>
</div><div><p>Can be used to dynamically provide playbackUrl and/or duration</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"playbackDetailsRequested"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaybackDetailsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaybackDetailsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"playbackDetailsRequested"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaybackDetailsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaybackDetailsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"playbackDetailsRequested"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>song: <a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaybackDetailsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaybackDetailsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"playbackDetailsRequested"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L798">index.d.ts:798</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when custom url corresponding to the extension is called
Callback should return data as buffer and mimetype for the same or undefined</p>
</div><div><p>if an url <code>extension://moosync.extension.packageName/testData</code> is provided to Moosync. When the url is fetched,
this event will be triggered and custom data can be provided at runtime</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><p>const song: Song = {
...,
song_coverPath_high: 'extension://moosync.extension.packageName/coverPathUrl',
...
playbackUrl: 'extension://moosync.extension.packageName/testData'
}</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"customRequest"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#CustomRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">CustomRequestReturnType</a><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#CustomRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">CustomRequestReturnType</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#CustomRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">CustomRequestReturnType</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L804">index.d.ts:804</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when user enters url in 'Add song from URL' modal
Callback should return parsed song or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedSongFromURL"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSongFromURL"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSongFromURL"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSongFromURL"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L813">index.d.ts:813</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when user enters url in 'Add playlist from URL' modal
Callback should return a playlist and parsed songs in that playlist or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedPlaylistFromURL"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaylistAndSongsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaylistAndSongsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedPlaylistFromURL"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaylistAndSongsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaylistAndSongsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedPlaylistFromURL"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#PlaylistAndSongsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">PlaylistAndSongsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedPlaylistFromURL"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L824">index.d.ts:824</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when user searches a term in search page
Callback should return a providerName and result songs or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedSearchResult"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>term<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SearchReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SearchReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSearchResult"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>term<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SearchReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SearchReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSearchResult"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>term: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SearchReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SearchReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSearchResult"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L833">index.d.ts:833</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when user opens Explore page
Callback should return a providerName and result songs or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedRecommendations"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#RecommendationsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">RecommendationsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedRecommendations"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#RecommendationsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">RecommendationsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedRecommendations"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#RecommendationsReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">RecommendationsReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedRecommendations"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L842">index.d.ts:842</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when lyrics are requested for a song
Callback should return a string (HTML formatting) with lyrics or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedLyrics"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedLyrics"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedLyrics"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>song: <a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedLyrics"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L851">index.d.ts:851</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when songs by a particular artist are requested
Callback should return parsed songs or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedArtistSongs"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>artist<span class="tsd-signature-symbol">: </span><a href="Artists.html" class="tsd-signature-type" data-tsd-kind="Interface">Artists</a>, nextPageToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedArtistSongs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>artist<span class="tsd-signature-symbol">: </span><a href="Artists.html" class="tsd-signature-type" data-tsd-kind="Interface">Artists</a>, nextPageToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedArtistSongs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>artist: <a href="Artists.html" class="tsd-signature-type" data-tsd-kind="Interface">Artists</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> nextPageToken: <span class="tsd-signature-type">unknown</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedArtistSongs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L863">index.d.ts:863</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when songs by a particular album are requested
Callback should return parsed songs or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedAlbumSongs"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>album<span class="tsd-signature-symbol">: </span><a href="Album.html" class="tsd-signature-type" data-tsd-kind="Interface">Album</a>, nextPageToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedAlbumSongs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>album<span class="tsd-signature-symbol">: </span><a href="Album.html" class="tsd-signature-type" data-tsd-kind="Interface">Album</a>, nextPageToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedAlbumSongs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>album: <a href="Album.html" class="tsd-signature-type" data-tsd-kind="Interface">Album</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> nextPageToken: <span class="tsd-signature-type">unknown</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongsWithPageTokenReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongsWithPageTokenReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedAlbumSongs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L875">index.d.ts:875</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when the app only has id for the song but requires complete details
Callback should return parsed song or undefined</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"requestedSongFromId"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSongFromId"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSongFromId"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#SongReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">SongReturnType</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#ForwardRequestReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">ForwardRequestReturnType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"requestedSongFromId"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L883">index.d.ts:883</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when songs are added to library</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"songAdded"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>songs<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>songs<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>songs: <a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L888">index.d.ts:888</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when songs are removed from library</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"songRemoved"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>songs<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>songs<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>songs: <a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L893">index.d.ts:893</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when playlist is added to library</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"playlistAdded"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>playlist<span class="tsd-signature-symbol">: </span><a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>playlist<span class="tsd-signature-symbol">: </span><a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>playlist: <a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L898">index.d.ts:898</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Event fired when playlist is removed from library</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">"playlistRemoved"</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>songs<span class="tsd-signature-symbol">: </span><a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>songs<span class="tsd-signature-symbol">: </span><a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>songs: <a href="Playlist.html" class="tsd-signature-type" data-tsd-kind="Interface">Playlist</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="openExternalURL" class="tsd-anchor"></a><h3>open<wbr/>ExternalURL</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">open<wbr/>ExternalURL<span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L713">index.d.ts:713</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Open a url in system browser</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>string corresponding to URL which is to be opened</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="openLoginModal" class="tsd-anchor"></a><h3>open<wbr/>Login<wbr/>Modal</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">open<wbr/>Login<wbr/>Modal<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules.html#LoginModalOptions" class="tsd-signature-type" data-tsd-kind="Type alias">LoginModalOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L961">index.d.ts:961</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Open login modal. Show the modal if the extension demands the user to open a linux
to fulfill OAuth requirements.</p>
</div><div><p>The modal also allows the user to manually enter a token or manually click a button when
the task is fulfilled</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../modules.html#LoginModalOptions" class="tsd-signature-type" data-tsd-kind="Type alias">LoginModalOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>options to control the oauth modal</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="registerAccount" class="tsd-anchor"></a><h3>register<wbr/>Account</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">register<wbr/>Account<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, bgColor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, icon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, signinCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span>, signoutCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L935">index.d.ts:935</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Add an account to show in accounts section in main app.
The user will then be able to perform login / logout operations on this account
and also view its details</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>name of service provider</p>
</div></div></li><li><h5>bgColor: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>background color to use for account card (in hex format. Eg. #000000)</p>
</div></div></li><li><h5>icon: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>icon of account (preferably service provider's icon)</p>
</div></div></li><li><h5>signinCallback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>callback fired when user wishes to login</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li><li><h5>signoutCallback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>callback fired when user wishes to logout</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div><p>generated accountId</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="registerOAuth" class="tsd-anchor"></a><h3>registerOAuth</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">registerOAuth<span class="tsd-signature-symbol">(</span>path<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L707">index.d.ts:707</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Register a callback for Oauth on given path. This OAuth can be triggered by calling the url
moosync://{path}
If the path matches, the whole URL is passed to this extension.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>path: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>path on which the callback will be triggered</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="removeContextMenuItem" class="tsd-anchor"></a><h3>remove<wbr/>Context<wbr/>Menu<wbr/>Item</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Context<wbr/>Menu<wbr/>Item<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L916">index.d.ts:916</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Remove an item from context menu</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>index: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>index of context menu item which is to be removed</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="removeSong" class="tsd-anchor"></a><h3>remove<wbr/>Song</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Song<span class="tsd-signature-symbol">(</span>song_id<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">remove<wbr/>Song<span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L679">index.d.ts:679</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>pass song instead of song_id
Remove song from library</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>song_id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>id of song to remove</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L685">index.d.ts:685</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Remove song from library</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>song: <a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>song to remove</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="removeUserPreference" class="tsd-anchor"></a><h3>remove<wbr/>User<wbr/>Preference</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">remove<wbr/>User<wbr/>Preference<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L996">index.d.ts:996</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="setAlbumEditableInfo" class="tsd-anchor"></a><h3>set<wbr/>Album<wbr/>Editable<wbr/>Info</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Album<wbr/>Editable<wbr/>Info<span class="tsd-signature-symbol">(</span>artist_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L988">index.d.ts:988</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set extra info for an album. This info is editable by the user using "Show info" context menu
option on album</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>artist_id: <span class="tsd-signature-type">string</span></h5></li><li><h5>object: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Key-value pairs of editable info</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="setArtistEditableInfo" class="tsd-anchor"></a><h3>set<wbr/>Artist<wbr/>Editable<wbr/>Info</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Artist<wbr/>Editable<wbr/>Info<span class="tsd-signature-symbol">(</span>artist_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L981">index.d.ts:981</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set extra info for an artist. This info is editable by the user using "Show info" context menu
option on artist</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>artist_id: <span class="tsd-signature-type">string</span></h5></li><li><h5>object: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Key-value pairs of editable info</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a name="setContextMenuItem" class="tsd-anchor"></a><h3>set<wbr/>Context<wbr/>Menu<wbr/>Item</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">set<wbr/>Context<wbr/>Menu<wbr/>Item<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>item<span class="tsd-signature-symbol">: </span><a href="../modules.html#ExtensionContextMenuItem" class="tsd-signature-type" data-tsd-kind="Type alias">ExtensionContextMenuItem</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</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><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L910">index.d.ts:910</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Adds new context menu item/s</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules.html#ContextMenuTypes" class="tsd-signature-type" data-tsd-kind="Type alias">ContextMenuTypes</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>item: <a href="../modules.html#ExtensionContextMenuItem" class="tsd-signature-type" data-tsd-kind="Type alias">ExtensionContextMenuItem</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>New menu item to show in context menu</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="setPreferences" class="tsd-anchor"></a><h3>set<wbr/>Preferences</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Preferences<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L645">index.d.ts:645</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set preference by key.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>key separated by '.'</p>
</div></div></li><li><h5>value: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>value to be stored for corresponding key</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="setSecure" class="tsd-anchor"></a><h3>set<wbr/>Secure</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Secure<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L659">index.d.ts:659</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Encrypt value and store in preferences</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>key separated by '.'</p>
</div></div></li><li><h5>value: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>value to be stored for corresponding key</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="showToast" class="tsd-anchor"></a><h3>show<wbr/>Toast</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">show<wbr/>Toast<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, duration<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"info"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"default"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L974">index.d.ts:974</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Show toast on top-right of screen</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>message to show in toast</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> duration: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>duration of toast in milliseconds. Maximum 5000ms</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> type: <span class="tsd-signature-type">"success"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"info"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"default"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>type of toast. Usually denotes color</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="updateSong" class="tsd-anchor"></a><h3>update<wbr/>Song</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>Song<span class="tsd-signature-symbol">(</span>song<span class="tsd-signature-symbol">: </span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Moosync/extension-api-types/blob/c5bc0f8/index.d.ts#L672">index.d.ts:672</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Update song in library by ID</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>song: <a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>song to update</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Song.html" class="tsd-signature-type" data-tsd-kind="Interface">Song</a><span class="tsd-signature-symbol">></span></h4></li></ul></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">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="extensionAPI.html" class="tsd-kind-icon">extensionAPI</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="extensionAPI.html#player" class="tsd-kind-icon">player</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="extensionAPI.html#utils" class="tsd-kind-icon">utils</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#addPlaylist" class="tsd-kind-icon">add<wbr/>Playlist</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#addSongs" class="tsd-kind-icon">add<wbr/>Songs</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#addSongsToPlaylist" class="tsd-kind-icon">add<wbr/>Songs<wbr/>To<wbr/>Playlist</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#addUserPreference" class="tsd-kind-icon">add<wbr/>User<wbr/>Preference</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#changeAccountAuthStatus" class="tsd-kind-icon">change<wbr/>Account<wbr/>Auth<wbr/>Status</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#closeLoginModal" class="tsd-kind-icon">close<wbr/>Login<wbr/>Modal</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getContextMenuItems" class="tsd-kind-icon">get<wbr/>Context<wbr/>Menu<wbr/>Items</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getCurrentSong" class="tsd-kind-icon">get<wbr/>Current<wbr/>Song</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#getEntity" class="tsd-kind-icon">get<wbr/>Entity</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getInstalledExtensions" class="tsd-kind-icon">get<wbr/>Installed<wbr/>Extensions</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getPlayerState" class="tsd-kind-icon">get<wbr/>Player<wbr/>State</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#getPreferences" class="tsd-kind-icon">get<wbr/>Preferences</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getQueue" class="tsd-kind-icon">get<wbr/>Queue</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#getSecure" class="tsd-kind-icon">get<wbr/>Secure</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getSongs" class="tsd-kind-icon">get<wbr/>Songs</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getTime" class="tsd-kind-icon">get<wbr/>Time</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#getVolume" class="tsd-kind-icon">get<wbr/>Volume</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#openExternalURL" class="tsd-kind-icon">open<wbr/>ExternalURL</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#openLoginModal" class="tsd-kind-icon">open<wbr/>Login<wbr/>Modal</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#registerAccount" class="tsd-kind-icon">register<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#registerOAuth" class="tsd-kind-icon">registerOAuth</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#removeContextMenuItem" class="tsd-kind-icon">remove<wbr/>Context<wbr/>Menu<wbr/>Item</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#removeSong" class="tsd-kind-icon">remove<wbr/>Song</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#removeUserPreference" class="tsd-kind-icon">remove<wbr/>User<wbr/>Preference</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#setAlbumEditableInfo" class="tsd-kind-icon">set<wbr/>Album<wbr/>Editable<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#setArtistEditableInfo" class="tsd-kind-icon">set<wbr/>Artist<wbr/>Editable<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="extensionAPI.html#setContextMenuItem" class="tsd-kind-icon">set<wbr/>Context<wbr/>Menu<wbr/>Item</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#setPreferences" class="tsd-kind-icon">set<wbr/>Preferences</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#setSecure" class="tsd-kind-icon">set<wbr/>Secure</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#showToast" class="tsd-kind-icon">show<wbr/>Toast</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="extensionAPI.html#updateSong" class="tsd-kind-icon">update<wbr/>Song</a></li></ul></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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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>