Blame view

sources/lib/public/iusersession.php 1.35 KB
03e52840d   Kload   Init
1
  <?php
03e52840d   Kload   Init
2
3
4
  /**
   * ownCloud
   *
31b7f2792   Kload   Upgrade to ownclo...
5
6
   * @author Bart Visscher
   * @copyright 2013 Bart Visscher bartv@thisnet.nl
03e52840d   Kload   Init
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
   *
   * 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/>.
   *
   */
31b7f2792   Kload   Upgrade to ownclo...
22
23
24
25
26
27
28
29
30
31
32
33
34
35
  /**
   * Public interface of ownCloud for apps to use.
   * User session interface
   *
   */
  
  // use OCP namespace for all classes that are considered public.
  // This means that they should be used by apps instead of the internal ownCloud classes
  namespace OCP;
  
  /**
   * User session
   */
  interface IUserSession {
03e52840d   Kload   Init
36
  	/**
31b7f2792   Kload   Upgrade to ownclo...
37
38
39
40
  	 * Do a user login
  	 * @param string $user the username
  	 * @param string $password the password
  	 * @return bool true if successful
03e52840d   Kload   Init
41
  	 */
31b7f2792   Kload   Upgrade to ownclo...
42
  	public function login($user, $password);
03e52840d   Kload   Init
43
44
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
45
46
  	 * Logs the user out including all the session data
  	 * Logout, destroys session
03e52840d   Kload   Init
47
  	 */
31b7f2792   Kload   Upgrade to ownclo...
48
  	public function logout();
03e52840d   Kload   Init
49
  }