<?php
  /**
   * ownCloud - App Framework
   *
   * @author Bernhard Posselt

   * @copyright 2012 Bernhard Posselt <dev@bernhard-posselt.com>

   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library 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 AFFERO GENERAL PUBLIC LICENSE for more details.
   *
   * You should have received a copy of the GNU Affero General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  /**
   * Public interface of ownCloud for apps to use.
   * AppFramework/IApi interface
   */
  
  namespace OCP\AppFramework;
  
  
  /**
   * A few very basic and frequently used API functions are combined in here
   */
  interface IApi {
  
  
  	/**
  	 * Gets the userid of the current user
  	 * @return string the user id of the current user
  	 */
  	function getUserId();
  
  
  	/**
  	 * Adds a new javascript file
  	 * @param string $scriptName the name of the javascript in js/ without the suffix
  	 * @param string $appName the name of the app, defaults to the current one

  	 * @return void

  	 */
  	function addScript($scriptName, $appName = null);
  
  
  	/**
  	 * Adds a new css file
  	 * @param string $styleName the name of the css file in css/without the suffix
  	 * @param string $appName the name of the app, defaults to the current one

  	 * @return void

  	 */
  	function addStyle($styleName, $appName = null);
  
  
  	/**
  	 * shorthand for addScript for files in the 3rdparty directory
  	 * @param string $name the name of the file without the suffix

  	 * @return void

  	 */
  	function add3rdPartyScript($name);
  
  
  	/**
  	 * shorthand for addStyle for files in the 3rdparty directory
  	 * @param string $name the name of the file without the suffix

  	 * @return void

  	 */
  	function add3rdPartyStyle($name);
  
  
  	/**
  	 * Checks if an app is enabled
  	 * @param string $appName the name of an app
  	 * @return bool true if app is enabled
  	 */
  	public function isAppEnabled($appName);
  
  }