@knora/api/src/api/admin/lists/lists-endpoint.d.ts

JavaScript library that handles API requests to Knora

import { Observable } from "rxjs";
import { ApiResponseData } from "../../../models/api-response-data";
import { ApiResponseError } from "../../../models/api-response-error";
import { Endpoint } from "../../endpoint";
import { CreateChildNodeRequest } from "../../../models/admin/create-child-node-request";
import { CreateListRequest } from "../../../models/admin/create-list-request";
import { ListInfoResponse } from "../../../models/admin/list-info-response";
import { ListNodeInfoResponse } from "../../../models/admin/list-node-info-response";
import { ListResponse } from "../../../models/admin/list-response";
import { ListsResponse } from "../../../models/admin/lists-response";
import { UpdateListInfoRequest } from "../../../models/admin/update-list-info-request";
/**
 * An endpoint for working with Knora lists.
 */
export declare class ListsEndpoint extends Endpoint {
    /**
     * Returns a list of lists.
     */
    getLists(): Observable<ApiResponseData<ListsResponse> | ApiResponseError>;
    /**
     * Returns a list of lists in a project.
     *
     * @param projectIri The IRI of the project.
     */
    getListsInProject(projectIri: string): Observable<ApiResponseData<ListsResponse> | ApiResponseError>;
    /**
     * Creates a list.
     *
     * @param listInfo Information about the list to be created.
     */
    createList(listInfo: CreateListRequest): Observable<ApiResponseData<ListResponse> | ApiResponseError>;
    /**
     * Gets a list.
     *
     * @param iri The IRI of the list.
     */
    getList(iri: string): Observable<ApiResponseData<ListResponse> | ApiResponseError>;
    /**
     * Updates information about a list.
     *
     * @param listInfo Information about the list to be created.
     */
    updateListInfo(listInfo: UpdateListInfoRequest): Observable<ApiResponseData<ListInfoResponse> | ApiResponseError>;
    /**
     * Creates a child node in a list.
     *
     * @param node The node to be created.
     */
    createChildNode(node: CreateChildNodeRequest): Observable<ApiResponseData<ListNodeInfoResponse> | ApiResponseError>;
    /**
     * Returns information about a list.
     *
     * @param iri The IRI of the list.
     */
    getListInfo(iri: string): Observable<ApiResponseData<ListInfoResponse> | ApiResponseError>;
    /**
     * Returns information about a list node.
     *
     * @param iri The IRI of the node.
     */
    getListNodeInfo(iri: string): Observable<ApiResponseData<ListNodeInfoResponse> | ApiResponseError>;
}