Interface ExtensionAPI

interface ExtensionAPI {
    addPlaylist(playlist): void;
    addSongs(songs): void;
    addToPlaylist(req): void;
    batchFetch(requests, options?): Promise<BatchFetchResponse[]>;
    fetch(request, options?): Promise<BatchFetchResponse>;
    getContext(): ExtensionContext;
    getCurrentSong(): Song;
    getPlayerState(): PlayerState;
    getPreference(data): PreferenceData;
    getQueue(): Song[];
    getSecure(data): PreferenceData;
    getSong(options): Song[];
    getTime(): number;
    getVolume(): number;
    on<K>(event, cb): void;
    openExternalUrl(url): void;
    registerOauth(url): boolean;
    registerUserPreferences(preferences): void;
    unregisterUserPreferences(preferenceIds): void;
    updateAccounts(accountId?): void;
}

Methods

addPlaylist

addPlaylist(playlist): void
Parameters
- playlist: Playlist
Returns void
- Defined in src/api.ts:169

addSongs

addSongs(songs): void
Parameters
- songs: Song[]
Returns void
- Defined in src/api.ts:170

addToPlaylist

addToPlaylist(req): void
Parameters
- req: AddToPlaylistRequest
Returns void
- Defined in src/api.ts:171

batchFetch

batchFetch(requests, options?): Promise<BatchFetchResponse[]>
Parameters
- requests: (string | BatchFetchRequest)[]
- Optional options: BatchFetchOptions
Returns Promise<BatchFetchResponse[]>
- Defined in src/api.ts:178

fetch

fetch(request, options?): Promise<BatchFetchResponse>
Parameters
- request: string | BatchFetchRequest
- Optional options: BatchFetchOptions
Returns Promise<BatchFetchResponse>
- Defined in src/api.ts:174

getContext

getContext(): ExtensionContext
Returns ExtensionContext
- Defined in src/api.ts:162

getCurrentSong

getCurrentSong(): Song
Returns Song
- Defined in src/api.ts:157

getPlayerState

getPlayerState(): PlayerState
Returns PlayerState
- Defined in src/api.ts:158

getPreference

getPreference(data): PreferenceData
Parameters
- data: PreferenceData
Returns PreferenceData
- Defined in src/api.ts:172

getQueue

getQueue(): Song[]
Returns Song[]
- Defined in src/api.ts:161

getSecure

getSecure(data): PreferenceData
Parameters
- data: PreferenceData
Returns PreferenceData
- Defined in src/api.ts:173

getSong

getSong(options): Song[]
Parameters
- options: GetSongOptions
Returns Song[]
- Defined in src/api.ts:156

getTime

getTime(): number
Returns number
- Defined in src/api.ts:160

getVolume

getVolume(): number
Returns number
- Defined in src/api.ts:159

on

on<K>(event, cb): void
Type Parameters
- K extends ExtensionEventCase
Parameters
- event: K
- cb: ((req) => void | ResponsePayload<K> | Promise<ResponsePayload<K>>)
  - - (req): void | ResponsePayload<K> | Promise<ResponsePayload<K>>
    - Parameters
      req: EventPayload<K>
      Returns void | ResponsePayload<K> | Promise<ResponsePayload<K>>
Returns void
- Defined in src/api.ts:149

openExternalUrl

openExternalUrl(url): void
Parameters
- url: string
Returns void
- Defined in src/api.ts:168

registerOauth

registerOauth(url): boolean
Parameters
- url: string
Returns boolean
- Defined in src/api.ts:165

registerUserPreferences

registerUserPreferences(preferences): void
Parameters
- preferences: PreferenceUiData[]
Returns void
- Defined in src/api.ts:166

unregisterUserPreferences

unregisterUserPreferences(preferenceIds): void
Parameters
- preferenceIds: string[]
Returns void
- Defined in src/api.ts:167

updateAccounts

updateAccounts(accountId?): void
Parameters
- Optional accountId: string
Returns void
- Defined in src/api.ts:164