Matrix/element-android-Github
1
0
Fork 0
mirror of https://github.com/vector-im/element-android.git synced 2024-11-16 02:05:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Create _userstories package and add the 2 first user stories

Browse Source
This commit is contained in:
Benoit Marty 2022-05-05 17:25:58 +02:00 committed by Benoit Marty
parent bad62be497
commit 96c825e265
3 changed files with 63 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
matrix-sdk-android/docs/packages.md
View File

@ -1,3 +1,7 @@
# Package org.matrix.android.sdk._userstories
This package contains some user stories (**Us** prefix) of the SDK usage. You will find example of what it is possible to do with the SDK and the API which can be used to do it.
# Package org.matrix.android.sdk.api
This is the root package of the API exposed by this SDK.

28
matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us000InitMatrix.kt Normal file
View File

@ -0,0 +1,28 @@
/*
* Copyright (c) 2022 The Matrix.org Foundation C.I.C.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@file:Suppress("unused")
package org.matrix.android.sdk._userstories
/**
* ### Title
* Init a Matrix object
*
* ### Required APIs:
* - [org.matrix.android.sdk.api.Matrix] constructor
*/
object Us000InitMatrix

31
matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us100SignIn.kt Normal file
View File

@ -0,0 +1,31 @@
/*
* Copyright (c) 2022 The Matrix.org Foundation C.I.C.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
@file:Suppress("unused")
package org.matrix.android.sdk._userstories
/**
* ### Title
* Sign in to an existing account
*
* #### Required APIs:
* - [org.matrix.android.sdk.api.Matrix.authenticationService]
* - [org.matrix.android.sdk.api.auth.AuthenticationService.getLoginFlow]
* - [org.matrix.android.sdk.api.auth.AuthenticationService.getLoginWizard]
* - [org.matrix.android.sdk.api.auth.login.LoginWizard.login]
*/
object Us100SignIn