Warning, /network/kaccounts-integration/README.md is written in an unsupported language. File is not indexed.

0001 # KAccounts Integration
0002 
0003 Integration library and QML module for Accounts-SSO and SignOn-SSO
0004 
0005 # Introduction
0006 
0007 KAccounts Integration provides a way to share accounts data such as login tokens and general
0008 user information (like usernames and such) between various applications.
0009 
0010 The KAccounts library is a KDE Frameworks style abstraction layer on top of the Accounts-SSO
0011 and SignOnD libraries, which uses a combination of models and jobs to expose the functionality
0012 of those.
0013 
0014 The kaccounts QML plugin exposes that functionality directly to Qt Quick based applications,
0015 and using the classes only requires importing the module like so:
0016 
0017 ```
0018 import org.kde.kaccounts 1.2 as KAccounts
0019 ```
0020 
0021 The main functionality in the library can be accessed through the various classes below, and
0022 the accounts manager can be accessed directly through ```KAccounts::accountsManager()```. The
0023 other central classes are:
0024 
0025 ## Models
0026 
0027 * AccountsModel
0028 * ServicesModel
0029 * ProvidersModel
0030 
0031 ## Jobs
0032 
0033 * AccountServiceToggleJob
0034 * ChangeAccountDisplayNameJob
0035 * CreateAccountJob
0036 * RemoveAccountJob
0037 
0038 # KDE Control Module
0039 
0040 The Online Accounts KCM is the main user-visible point for KAccounts, and can be accessed
0041 either through System Settings, or directly from any system menu which allows launching of
0042 KCMs directly (including KRunner). It is built using the Qt Quick module mentioned above,
0043 and uses Kirigami as its base.
0044 
0045 # Provider and Service files
0046 
0047 If you plan on creating new providers and services, you will need to register those with
0048 the accounts manager. Two cmake macros are provided to assist you in the creation and
0049 installation of these files, and further assists in translation integration for them:
0050 
0051 * kaccounts_add_provider
0052 * kaccounts_add_service