Playlists

Queries

useFeaturedPlaylistsQuery(queryOptions?: UseQueryOptions): {playlists: IPlaylist[], ...UseQueryResult}

Used for querying list of playlists, which are currently marked as featured on spinamp.

usePlaylistDetailsQuery(playlistId: string, queryOptions?: UseQueryOptions): {playlist: IPlaylist | null, playlistTracks: ITrack[], ...UseQueryResult}

Used for querying playlist details based on provided playlist id. It returns playlist object and playlistTracks array containing list of full tracks objects belonging to provided playlist.

useCollectorPlaylistsQuery(ethAddress: string, queryOptions?: UseQueryOptions): {playlists: IPlaylist[], ...UseQueryResult}

Used for querying list of playlists, created by user with provided ethereum address.

Mutations

useCreatePlaylistMutation(mutationOptions?: UseMutationOptions): {mutate: ({playlist: Omit<IPlaylist, 'id'>, signer: Signer}), ...UseMutationResult}

Used for playlist creation. Hook returns mutate function which takes new playlist object and ethers signer object for API authentication.

useUpdatePlaylistMutation(mutationOptions?: UseMutationOptions): {mutate: ({id: string, playlist: Partial<IPlaylist>, signer: Signer}), ...UseMutationResult}

Used for updating playlist. Hook returns mutate function which takes id of edited playlist, playlist object with properties to update and ethers signer object for API authentication.