javascript-ampache
Version:
A JS library for the Ampache API
92 lines (91 loc) • 3.78 kB
TypeScript
import { BookmarkResponse, BookmarksResponse } from "./types";
import { Base, BinaryBoolean, Success, UID } from "../base";
export declare class Bookmarks extends Base {
/**
* Get a single bookmark by bookmark_id
* @remarks MINIMUM_API_VERSION=6.1.0
* @param params.filter UID to find
* @param [params.include] 0,1, if true include the object in the bookmark
* @see {@link https://ampache.org/api/api-json-methods#bookmark}
*/
bookmark(params: {
filter: UID;
include?: BinaryBoolean;
}): Promise<BookmarkResponse>;
/**
* Get information about bookmarked media this user is allowed to manage
* @remarks MINIMUM_API_VERSION=5.0.0
* @param [params.client] filter by the agent/client name
* @param [params.include] 0,1, if true include the object in the bookmark
* @see {@link https://ampache.org/api/api-json-methods#bookmarks}
*/
bookmarks(params: {
client?: string;
include?: BinaryBoolean;
}): Promise<BookmarksResponse>;
/**
* Get the bookmark/s from its object_id and object_type.
* @remarks MINIMUM_API_VERSION=5.0.0
* @param params.filter UID to find
* @param params.type Object type
* @param [params.include] 0,1, if true include the object in the bookmark
* @see {@link https://ampache.org/api/api-json-methods#get_bookmark}
*/
getBookmark(params: {
filter: UID;
type: "song" | "video" | "podcast_episode";
include?: BinaryBoolean;
all?: BinaryBoolean;
}): Promise<BookmarkResponse>;
/**
* Create a placeholder for the current media that you can return to later.
* @remarks MINIMUM_API_VERSION=5.0.0
* @param params.filter UID to find
* @param params.type Object type
* @param params.position current track time in seconds
* @param [params.client] Agent string. (Default: 'AmpacheAPI')
* @param [params.date] update time (Default: UNIXTIME())
* @param [params.include] 0,1, if true include the object in the bookmark
* @see {@link https://ampache.org/api/api-json-methods#bookmark_create}
*/
bookmarkCreate(params: {
filter: UID;
type: "song" | "video" | "podcast_episode";
position: number;
client?: string;
date?: number;
include?: BinaryBoolean;
}): Promise<BookmarkResponse>;
/**
* Edit a placeholder for the current media that you can return to later.
* @remarks MINIMUM_API_VERSION=5.0.0
* @param params.filter UID to find
* @param params.type Object type
* @param params.position current track time in seconds
* @param [params.client] Agent string. (Default: 'AmpacheAPI')
* @param [params.date] update time (Default: UNIXTIME())
* @param [params.include] 0,1, if true include the object in the bookmark
* @see {@link https://ampache.org/api/api-json-methods#bookmark_edit}
*/
bookmarkEdit(params: {
filter: UID;
type: "song" | "video" | "podcast_episode";
position: number;
client?: string;
date?: number;
include?: BinaryBoolean;
}): Promise<BookmarkResponse>;
/**
* Delete an existing bookmark. (if it exists)
* @remarks MINIMUM_API_VERSION=5.0.0
* @param params.filter UID to find
* @param params.type Object type
* @param [params.client] Agent string. (Default: 'AmpacheAPI')
@see {@link https://ampache.org/api/api-json-methods#bookmark_delete}
*/
bookmarkDelete(params: {
filter: UID;
type: "song" | "video" | "podcast_episode";
client?: string;
}): Promise<Success>;
}