onlyoffice_docspace-1.1.0/src/Manager/RequestManager/RequestManagerInterface.php

<?php

namespace Drupal\onlyoffice_docspace\Manager\RequestManager;

/**
 * Copyright (c) Ascensio System SIA 2024.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

/**
 * An interface for ONLYOFFICE DocSpace Request Manager.
 */
interface RequestManagerInterface {

  const UNAUTHORIZED = 1;
  const USER_NOT_FOUND = 2;
  const FORBIDDEN = 3;
  const ERROR_USER_INVITE = 4;
  const ERROR_GET_USERS = 5;
  const ERROR_SET_USER_PASS = 6;

  /**
   * Connect to ONLYOFFICE DocSapace.
   *
   * @param string $url
   *   The ONLYOFFICE DocSpace URL.
   * @param string $login
   *   The ONLYOFFICE DocSpace user login.
   * @param string $password_hash
   *   The ONLYOFFICE DocSpace user password.
   */
  public function connectDocSpace($url = NULL, $login = NULL, $password_hash = NULL);

  /**
   * Get ONLYOFFICE DocSpace user.
   *
   * @param string $url
   *   The ONLYOFFICE DocSpace URL.
   * @param string $login
   *   The ONLYOFFICE DocSpace user login.
   * @param string $token
   *   The ONLYOFFICE DocSpace token.
   */
  public function getDocSpaceUser($url, $login, $token);

  /**
   * Get ONLYOFFICE DocSpace users.
   */
  public function getDocSpaceUsers();

  /**
   * Invite user to ONLYOFFICE DocSpace.
   *
   * @param string $email
   *   User email.
   * @param string $password_hash
   *   User password hash.
   * @param string $firstname
   *   User firstname.
   * @param string $lastname
   *   User lastname.
   * @param string $type
   *   User type.
   * @param string $token
   *   DocSpace token.
   */
  public function inviteToDocSpace($email, $password_hash, $firstname, $lastname, $type, $token = NULL);

  /**
   * Set ONLYOFFICE DocSpace user password.
   *
   * @param string $user_id
   *   The ONLYOFFICE DocSpace user ID.
   * @param string $password_hash
   *   The ONLYOFFICE DocSpace user password hash.
   * @param string $token
   *   The ONLYOFFICE DocSpace token.
   */
  public function setUserPassword($user_id, $password_hash, $token);

}