Changeset View
Changeset View
Standalone View
Standalone View
README.md
- This file was added.
1 | # KAccounts Integration | ||||
---|---|---|---|---|---|
2 | | ||||
3 | Integration library and QML module for Accounts-SSO and SignOn-SSO | ||||
4 | | ||||
5 | # Introduction | ||||
6 | | ||||
7 | KAccounts Integration provides a way to share accounts data such as login tokens and general | ||||
8 | user information (like usernames and such) between various applications. | ||||
9 | | ||||
10 | The KAccounts library is a KDE Frameworks style abstraction layer on top of the Accounts-SSO | ||||
11 | and SignOnD libraries, which uses a combination of models and jobs to expose the functionality | ||||
12 | of those. | ||||
13 | | ||||
14 | The kaccounts QML plugin exposes that functionality directly to Qt Quick based applications, | ||||
15 | and using the classes only requires importing the module like so: | ||||
16 | | ||||
17 | ``` | ||||
18 | import org.kde.kaccounts 1.2 as KAccounts | ||||
19 | ``` | ||||
20 | | ||||
21 | The main functionality in the library can be accessed through the various classes below, and | ||||
22 | the accounts manager can be accessed directly through ```KAccounts::accountsManager()```. The | ||||
23 | other central classes are: | ||||
24 | | ||||
25 | ## Models | ||||
26 | | ||||
27 | * AccountsModel | ||||
28 | * ServicesModel | ||||
29 | * ProvidersModel | ||||
30 | | ||||
31 | ## Jobs | ||||
32 | | ||||
33 | * AccountServiceToggleJob | ||||
34 | * ChangeAccountDisplayNameJob | ||||
35 | * CreateAccountJob | ||||
36 | * RemoveAccountJob | ||||
37 | | ||||
38 | # KDE Control Module | ||||
39 | | ||||
40 | The Online Accounts KCM is the main user-visible point for KAccounts, and can be accessed | ||||
41 | either through System Settings, or directly from any system menu which allows launching of | ||||
42 | KCMs directly (including KRunner). It is built using the Qt Quick module mentioned above, | ||||
43 | and uses Kirigami as its base. | ||||
44 | | ||||
45 | # Provider and Service files | ||||
46 | | ||||
47 | If you plan on creating new providers and services, you will need to register those with | ||||
48 | the accounts manager. Two cmake macros are provided to assist you in the creation and | ||||
49 | installation of these files, and further assists in translation integration for them: | ||||
50 | | ||||
51 | * kaccounts_add_provider | ||||
52 | * kaccounts_add_service |