From 0aa344dc247c77376fcbf2112191f9f8b3dfc846 Mon Sep 17 00:00:00 2001
From: Jeremy Benoist <jeremy.benoist@gmail.com>
Date: Thu, 24 Dec 2015 15:22:56 +0100
Subject: Update url & service name

Prefix ur with service namel: [service]_[route name]
Add comment in Interface
---
 .../ImportBundle/Import/ImportInterface.php        | 33 ++++++++++++++++++++++
 1 file changed, 33 insertions(+)

(limited to 'src/Wallabag/ImportBundle/Import/ImportInterface.php')

diff --git a/src/Wallabag/ImportBundle/Import/ImportInterface.php b/src/Wallabag/ImportBundle/Import/ImportInterface.php
index f07a120c..0f9b3256 100644
--- a/src/Wallabag/ImportBundle/Import/ImportInterface.php
+++ b/src/Wallabag/ImportBundle/Import/ImportInterface.php
@@ -4,9 +4,42 @@ namespace Wallabag\ImportBundle\Import;
 
 interface ImportInterface
 {
+    /**
+     * Name of the import.
+     *
+     * @return string
+     */
     public function getName();
+
+    /**
+     * Description of the import.
+     *
+     * @return string
+     */
     public function getDescription();
+
+    /**
+     * Return the oauth url to authenticate the client.
+     *
+     * @param string $redirectUri Redirect url in case of error
+     * @param string $callbackUri Url when the authentication is complete
+     *
+     * @return string
+     */
     public function oAuthRequest($redirectUri, $callbackUri);
+
+    /**
+     * Usually called by the previous callback to authorize the client.
+     * Then it return a token that can be used for next requests.
+     *
+     * @return string
+     */
     public function oAuthAuthorize();
+
+    /**
+     * Import content using the user token.
+     *
+     * @param string $accessToken User access token
+     */
     public function import($accessToken);
 }
-- 
cgit v1.2.3