From 96c825e265fd2f183f954760a6ed8d00fca47bca Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Thu, 5 May 2022 17:25:58 +0200
Subject: [PATCH] Create _userstories package and add the 2 first user stories

---
 matrix-sdk-android/docs/packages.md           |  4 +++
 .../sdk/_userstories/Us000InitMatrix.kt       | 28 +++++++++++++++++
 .../android/sdk/_userstories/Us100SignIn.kt   | 31 +++++++++++++++++++
 3 files changed, 63 insertions(+)
 create mode 100644 matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us000InitMatrix.kt
 create mode 100644 matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us100SignIn.kt

diff --git a/matrix-sdk-android/docs/packages.md b/matrix-sdk-android/docs/packages.md
index ae7bee1b4e..98b0e0c034 100644
--- a/matrix-sdk-android/docs/packages.md
+++ b/matrix-sdk-android/docs/packages.md
@@ -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.
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us000InitMatrix.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us000InitMatrix.kt
new file mode 100644
index 0000000000..823a9522cf
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us000InitMatrix.kt
@@ -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
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us100SignIn.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us100SignIn.kt
new file mode 100644
index 0000000000..5344e19ae4
--- /dev/null
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/_userstories/Us100SignIn.kt
@@ -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