Appwrite/sdk-for-android
1
0
Fork 0
mirror of https://github.com/appwrite/sdk-for-android.git synced 2026-04-07 19:17:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: update for 1.0.0-RC1

Browse Source
This commit is contained in:
Christy Jacob
2022-09-06 20:44:37 +04:00
parent 962b8dabe7
commit 84cd2a938e
6 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
library/src/main/java/io/appwrite/models/RealtimeModels.kt
+1 -1
View File
@@ -23,7 +23,7 @@ open class RealtimeResponse(
data class RealtimeResponseEvent<T>(
val events: Collection<String>,
val channels: Collection<String>,
val timestamp: Long,
val timestamp: String,
var payload: T
)
library/src/main/java/io/appwrite/services/Account.kt
+8 -8
View File
@@ -55,7 +55,7 @@ class Account : Service {
* login to their new account, you need to create a new [account
* session](/docs/client/account#accountCreateSession).
*
* @param userId Unique Id. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
* @param userId Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
* @param email User email.
* @param password User password. Must be at least 8 chars.
* @param name User name. Max length: 128 chars.
@@ -282,7 +282,7 @@ class Account : Service {
* /account/verification/phone](/docs/client/account#accountCreatePhoneVerification)
* endpoint to send a confirmation SMS.
*
* @param phone Phone number. Format this number with a leading &#039;+&#039; and a country code, e.g., +16175551212.
* @param phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
* @param password User password. Must be at least 8 chars.
* @return [io.appwrite.models.Account]
*/
@@ -612,7 +612,7 @@ class Account : Service {
* the URL parameter empty, so that the login completion will be handled by
* your Appwrite instance by default.
*
* @param userId Unique Id. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
* @param userId Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
* @param email User email.
* @param url URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
* @return [io.appwrite.models.Token]
@@ -784,8 +784,8 @@ class Account : Service {
* endpoint to complete the login process. The secret sent to the user's phone
* is valid for 15 minutes.
*
* @param userId Unique Id. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
* @param phone Phone number. Format this number with a leading &#039;+&#039; and a country code, e.g., +16175551212.
* @param userId Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
* @param phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
* @return [io.appwrite.models.Token]
*/
@JvmOverloads
@@ -861,7 +861,7 @@ class Account : Service {
* Use this endpoint to get a logged in user's session using a Session ID.
* Inputting 'current' will return the current session being used.
*
* @param sessionId Session ID. Use the string &#039;current&#039; to get the current device session.
* @param sessionId Session ID. Use the string 'current' to get the current device session.
* @return [io.appwrite.models.Session]
*/
@JvmOverloads
@@ -895,7 +895,7 @@ class Account : Service {
* If session was created using an OAuth provider, this route can be used to
* "refresh" the access token.
*
* @param sessionId Session ID. Use the string &#039;current&#039; to update the current device session.
* @param sessionId Session ID. Use the string 'current' to update the current device session.
* @return [io.appwrite.models.Session]
*/
@JvmOverloads
@@ -930,7 +930,7 @@ class Account : Service {
* Session ID argument, only the unique session ID provided is deleted.
*
*
* @param sessionId Session ID. Use the string &#039;current&#039; to delete the current device session.
* @param sessionId Session ID. Use the string 'current' to delete the current device session.
* @return [Any]
*/
@JvmOverloads
library/src/main/java/io/appwrite/services/Avatars.kt
+1 -1
View File
@@ -270,7 +270,7 @@ class Avatars : Service {
* @param text Plain text to be converted to QR code image.
* @param size QR code size. Pass an integer between 1 to 1000. Defaults to 400.
* @param margin Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
* @param download Return resulting image with &#039;Content-Disposition: attachment &#039; headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
* @param download Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
* @return [ByteArray]
*/
@JvmOverloads
library/src/main/java/io/appwrite/services/Databases.kt
+1 -1
View File
@@ -62,7 +62,7 @@ class Databases : Service {
*
* @param databaseId Database ID.
* @param collectionId Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.
* @param documentId Document ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
* @param documentId Document ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
* @param data Document data as JSON object.
* @param permissions An array of permissions strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions).
* @return [io.appwrite.models.Document]
library/src/main/java/io/appwrite/services/Storage.kt
+1 -1
View File
@@ -77,7 +77,7 @@ class Storage : Service {
*
*
* @param bucketId Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
* @param fileId File ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
* @param fileId File ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
* @param file Binary file.
* @param permissions An array of permission strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions).
* @return [io.appwrite.models.File]
library/src/main/java/io/appwrite/services/Teams.kt
+2 -2
View File
@@ -59,7 +59,7 @@ class Teams : Service {
* assigned as the owner of the team. Only the users with the owner role can
* invite new members, add new owners and delete or update the team.
*
* @param teamId Team ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
* @param teamId Team ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
* @param name Team name. Max length: 128 chars.
* @param roles Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
* @return [io.appwrite.models.Team]
@@ -331,7 +331,7 @@ class Teams : Service {
*
* @param teamId Team ID.
* @param membershipId Membership ID.
* @param roles An array of strings. Use this param to set the user&#039;s roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
* @param roles An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
* @return [io.appwrite.models.Membership]
*/
@JvmOverloads