@knora/api/src/api/admin/projects/projects-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 { KeywordsResponse } from "../../../models/admin/keywords-response";
import { MembersResponse } from "../../../models/admin/members-response";
import { Project } from "../../../models/admin/project";
import { ProjectResponse } from "../../../models/admin/project-response";
import { ProjectRestrictedViewSettingsResponse } from "../../../models/admin/project-restricted-view-settings-response";
import { ProjectsResponse } from "../../../models/admin/projects-response";
import { UpdateProjectRequest } from "../../../models/admin/update-project-request";
/**
 * An endpoint for working with Knora projects.
 */
export declare class ProjectsEndpoint extends Endpoint {
    /**
     * Returns a list of all projects.
     */
    getProjects(): Observable<ApiResponseData<ProjectsResponse> | ApiResponseError>;
    /**
     * Creates a project.
     *
     * @param project The project to be created.
     */
    createProject(project: Project): Observable<ApiResponseData<ProjectResponse> | ApiResponseError>;
    /**
     * Gets all the unique keywords for all projects.
     */
    getKeywords(): Observable<ApiResponseData<KeywordsResponse> | ApiResponseError>;
    /**
     * Gets all the keywords for a project.
     *
     * @param iri The IRI of the project.
     */
    getProjectKeywords(iri: string): Observable<ApiResponseData<KeywordsResponse> | ApiResponseError>;
    /**
     * Updates a project.
     *
     * @param iri The IRI of the project to be updated.
     * @param projectInfo The project info to be updated.
     */
    updateProject(iri: string, projectInfo: UpdateProjectRequest): Observable<ApiResponseData<ProjectResponse> | ApiResponseError>;
    /**
     * Deletes a project. This method does not actually delete a project, but sets the status to false.
     *
     * @param iri The project IRI.
     */
    deleteProject(iri: string): Observable<ApiResponseData<ProjectResponse> | ApiResponseError>;
    /**
     * Gets a project by a property.
     *
     * @param property The name of the property by which the project is identified.
     * @param value The value of the property by which the project is identified.
     */
    getProject(property: "iri" | "shortname" | "shortcode", value: string): Observable<ApiResponseData<ProjectResponse> | ApiResponseError>;
    /**
     * Gets a project by IRI.
     *
     * @param iri The IRI of the project.
     */
    getProjectByIri(iri: string): Observable<ApiResponseData<ProjectResponse> | ApiResponseError>;
    /**
     * Gets a project by shortname.
     *
     * @param shortname The shortname of the project.
     */
    getProjectByShortname(shortname: string): Observable<ApiResponseData<ProjectResponse> | ApiResponseError>;
    /**
     * Gets a project by shortcode.
     *
     * @param shortcode The shortcode of the project.
     */
    getProjectByShortcode(shortcode: string): Observable<ApiResponseData<ProjectResponse> | ApiResponseError>;
    /**
     * Gets a project's members by a property.
     *
     * @param property The name of the property by which the project is identified.
     * @param value The value of the property by which the project is identified.
     */
    getProjectMembers(property: "iri" | "shortname" | "shortcode", value: string): Observable<ApiResponseData<MembersResponse> | ApiResponseError>;
    /**
     * Gets the members of a project by IRI.
     *
     * @param iri The IRI of the project.
     */
    getProjectMembersByIri(iri: string): Observable<ApiResponseData<MembersResponse> | ApiResponseError>;
    /**
     * Gets a project's members by shortname.
     *
     * @param shortname The shortname of the project.
     */
    getProjectMembersByShortname(shortname: string): Observable<ApiResponseData<MembersResponse> | ApiResponseError>;
    /**
     * Gets a project's members by shortcode.
     *
     * @param shortcode The shortcode of the project.
     */
    getProjectMembersByShortcode(shortcode: string): Observable<ApiResponseData<MembersResponse> | ApiResponseError>;
    /**
     * Gets a project's admin members by a property.
     *
     * @param property The name of the property by which the project is identified.
     * @param value The value of the property by which the project is identified.
     */
    getProjectAdminMembers(property: "iri" | "shortname" | "shortcode", value: string): Observable<ApiResponseData<MembersResponse> | ApiResponseError>;
    /**
     * Gets the admin members of a project by IRI.
     *
     * @param iri The IRI of the project.
     */
    getProjectAdminMembersByIri(iri: string): Observable<ApiResponseData<MembersResponse> | ApiResponseError>;
    /**
     * Gets a project's admin members by shortname.
     *
     * @param shortname The shortname of the project.
     */
    getProjectAdminMembersByShortname(shortname: string): Observable<ApiResponseData<MembersResponse> | ApiResponseError>;
    /**
     * Gets a project's admin members by shortcode.
     *
     * @param shortcode The shortcode of the project.
     */
    getProjectAdminMembersByShortcode(shortcode: string): Observable<ApiResponseData<MembersResponse> | ApiResponseError>;
    /**
     * Gets a project's restricted view settings by a property.
     *
     * @param property The name of the property by which the project is identified.
     * @param value The value of the property by which the project is identified.
     */
    getProjectRestrictedViewSettings(property: "iri" | "shortname" | "shortcode", value: string): Observable<ApiResponseData<ProjectRestrictedViewSettingsResponse> | ApiResponseError>;
    /**
     * Gets a project's restricted view settings by IRI.
     *
     * @param iri The IRI of the project.
     */
    getProjectRestrictedViewSettingByIri(iri: string): Observable<ApiResponseData<ProjectRestrictedViewSettingsResponse> | ApiResponseError>;
    /**
     * Gets a project's restricted view settings by shortname.
     *
     * @param shortname The shortname of the project.
     */
    getProjectRestrictedViewSettingByShortname(shortname: string): Observable<ApiResponseData<ProjectRestrictedViewSettingsResponse> | ApiResponseError>;
    /**
     * Gets a project's restricted view settings by shortcode.
     *
     * @param shortcode The shortcode of the project.
     */
    getProjectRestrictedViewSettingByShortcode(shortcode: string): Observable<ApiResponseData<ProjectRestrictedViewSettingsResponse> | ApiResponseError>;
}