Update url & service name

[github/wallabag/wallabag.git] / src / Wallabag / ImportBundle / Import / ImportInterface.php

diff --git a/src/Wallabag/ImportBundle/Import/ImportInterface.php b/src/Wallabag/ImportBundle/Import/ImportInterface.php
index f07a120cf5cd8b7262e8985f08818c8e470771b1..0f9b3256949b81869eed65d53120afdcf7b43708 100644 (file)
--- 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);
 }