IAccountAuthenticator.aidl revision d4a1d2e14297a3387fdb5761090961e714370492 
1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.accounts;
18
19import android.accounts.IAccountAuthenticatorResponse;
20import android.accounts.Account;
21import android.os.Bundle;
22
23/**
24 * Service that allows the interaction with an authentication server.
25 */
26oneway interface IAccountAuthenticator {
27    /**
28     * prompts the user for account information and adds the result to the IAccountManager
29     */
30    void addAccount(in IAccountAuthenticatorResponse response, String accountType,
31        String authTokenType, in String[] requiredFeatures, in Bundle options);
32
33    /**
34     * Checks that the account/password combination is valid.
35     * @deprecated
36     */
37    void confirmPassword(in IAccountAuthenticatorResponse response,
38        in Account account, String password);
39
40    /**
41     * prompts the user for the credentials of the account
42     */
43    void confirmCredentials(in IAccountAuthenticatorResponse response, in Account account);
44
45    /**
46     * gets the password by either prompting the user or querying the IAccountManager
47     */
48    void getAuthToken(in IAccountAuthenticatorResponse response, in Account account,
49        String authTokenType, in Bundle options);
50
51    /**
52     * Gets the user-visible label of the given authtoken type.
53     */
54    void getAuthTokenLabel(in IAccountAuthenticatorResponse response, String authTokenType);
55
56    /**
57     * prompts the user for a new password and writes it to the IAccountManager
58     */
59    void updateCredentials(in IAccountAuthenticatorResponse response, in Account account,
60        String authTokenType, in Bundle options);
61
62    /**
63     * launches an activity that lets the user edit and set the properties for an authenticator
64     */
65    void editProperties(in IAccountAuthenticatorResponse response, String accountType);
66
67    /**
68     * returns a Bundle where the boolean value BOOLEAN_RESULT_KEY is set if the account has the
69     * specified features
70     */
71    void hasFeatures(in IAccountAuthenticatorResponse response, in Account account,
72        in String[] features);
73}
74