aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/Wallabag/ImportBundle/Import/ImportInterface.php
blob: 0f9b3256949b81869eed65d53120afdcf7b43708 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?php

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);
}