nextcloud-server/lib/public/ContextChat/IContentProvider.php

<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2024-2025 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCP\ContextChat;

/**
 * This interface defines methods to implement a content provider
 * @since 32.0.0
 */
interface IContentProvider {
	/**
	 * The ID of the provider
	 *
	 * @return string
	 * @since 32.0.0
	 */
	public function getId(): string;

	/**
	 * The ID of the app making the provider avaialble
	 *
	 * @return string
	 * @since 32.0.0
	 */
	public function getAppId(): string;

	/**
	 * The absolute URL to the content item
	 *
	 * @param string $id
	 * @return string
	 * @since 32.0.0
	 */
	public function getItemUrl(string $id): string;

	/**
	 * Starts the initial import of content items into context chat
	 *
	 * @return void
	 * @since 32.0.0
	 */
	public function triggerInitialImport(): void;
}