updated specs

This commit is contained in:
ArnabChatterjee20k
2026-02-13 17:04:34 +00:00
parent 364de481b9
commit 471adb7842
104 changed files with 207 additions and 105 deletions
+2 -2
View File
@@ -38,7 +38,7 @@ repositories {
Next, add the dependency to your project's `build.gradle(.kts)` file:
```groovy
implementation("io.appwrite:sdk-for-android:12.1.0")
implementation("io.appwrite:sdk-for-android:12.3.0")
```
### Maven
@@ -49,7 +49,7 @@ Add this to your project's `pom.xml` file:
<dependency>
<groupId>io.appwrite</groupId>
<artifactId>sdk-for-android</artifactId>
<version>12.1.0</version>
<version>12.3.0</version>
</dependency>
</dependencies>
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.createEmailPasswordSession(
email = "email@example.com",
password = "password",
)```
)
```
@@ -13,4 +13,5 @@ val result = account.createEmailToken(
userId = "<USER_ID>",
email = "email@example.com",
phrase = false, // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.createEmailVerification(
url = "https://example.com",
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.createJWT(
duration = 0, // (optional)
)```
)
```
@@ -14,4 +14,5 @@ val result = account.createMagicURLToken(
email = "email@example.com",
url = "https://example.com", // (optional)
phrase = false, // (optional)
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.createMFAAuthenticator(
type = AuthenticatorType.TOTP,
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.createMFAChallenge(
factor = AuthenticationFactor.EMAIL,
)```
)
```
@@ -15,4 +15,5 @@ account.createOAuth2Session(
success = "https://example.com", // (optional)
failure = "https://example.com", // (optional)
scopes = listOf(), // (optional)
)```
)
```
@@ -15,4 +15,5 @@ account.createOAuth2Token(
success = "https://example.com", // (optional)
failure = "https://example.com", // (optional)
scopes = listOf(), // (optional)
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.createPhoneToken(
userId = "<USER_ID>",
phone = "+12065550100",
)```
)
```
@@ -13,4 +13,5 @@ val result = account.createPushTarget(
targetId = "<TARGET_ID>",
identifier = "<IDENTIFIER>",
providerId = "<PROVIDER_ID>", // (optional)
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.createRecovery(
email = "email@example.com",
url = "https://example.com",
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.createSession(
userId = "<USER_ID>",
secret = "<SECRET>",
)```
)
```
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.createVerification(
url = "https://example.com",
)```
)
```
+2 -1
View File
@@ -14,4 +14,5 @@ val result = account.create(
email = "email@example.com",
password = "",
name = "<NAME>", // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.deleteIdentity(
identityId = "<IDENTITY_ID>",
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.deleteMFAAuthenticator(
type = AuthenticatorType.TOTP,
)```
)
```
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.deletePushTarget(
targetId = "<TARGET_ID>",
)```
)
```
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.deleteSession(
sessionId = "<SESSION_ID>",
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.getSession(
sessionId = "<SESSION_ID>",
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.listIdentities(
queries = listOf(), // (optional)
total = false, // (optional)
)```
)
```
+2 -1
View File
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.listLogs(
queries = listOf(), // (optional)
total = false, // (optional)
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updateEmailVerification(
userId = "<USER_ID>",
secret = "<SECRET>",
)```
)
```
+2 -1
View File
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updateEmail(
email = "email@example.com",
password = "password",
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updateMagicURLSession(
userId = "<USER_ID>",
secret = "<SECRET>",
)```
)
```
@@ -13,4 +13,5 @@ val account = Account(client)
val result = account.updateMFAAuthenticator(
type = AuthenticatorType.TOTP,
otp = "<OTP>",
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updateMFAChallenge(
challengeId = "<CHALLENGE_ID>",
otp = "<OTP>",
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.updateMFA(
mfa = false,
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.updateName(
name = "<NAME>",
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updatePassword(
password = "",
oldPassword = "password", // (optional)
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updatePhoneSession(
userId = "<USER_ID>",
secret = "<SECRET>",
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updatePhoneVerification(
userId = "<USER_ID>",
secret = "<SECRET>",
)```
)
```
+2 -1
View File
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updatePhone(
phone = "+12065550100",
password = "password",
)```
)
```
+2 -1
View File
@@ -15,4 +15,5 @@ val result = account.updatePrefs(
"timezone" to "UTC",
"darkTheme" to true
),
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updatePushTarget(
targetId = "<TARGET_ID>",
identifier = "<IDENTIFIER>",
)```
)
```
@@ -13,4 +13,5 @@ val result = account.updateRecovery(
userId = "<USER_ID>",
secret = "<SECRET>",
password = "",
)```
)
```
@@ -11,4 +11,5 @@ val account = Account(client)
val result = account.updateSession(
sessionId = "<SESSION_ID>",
)```
)
```
@@ -12,4 +12,5 @@ val account = Account(client)
val result = account.updateVerification(
userId = "<USER_ID>",
secret = "<SECRET>",
)```
)
```
+2 -1
View File
@@ -15,4 +15,5 @@ val result = avatars.getBrowser(
width = 0, // (optional)
height = 0, // (optional)
quality = -1, // (optional)
)```
)
```
@@ -15,4 +15,5 @@ val result = avatars.getCreditCard(
width = 0, // (optional)
height = 0, // (optional)
quality = -1, // (optional)
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val avatars = Avatars(client)
val result = avatars.getFavicon(
url = "https://example.com",
)```
)
```
+2 -1
View File
@@ -15,4 +15,5 @@ val result = avatars.getFlag(
width = 0, // (optional)
height = 0, // (optional)
quality = -1, // (optional)
)```
)
```
+2 -1
View File
@@ -13,4 +13,5 @@ val result = avatars.getImage(
url = "https://example.com",
width = 0, // (optional)
height = 0, // (optional)
)```
)
```
+2 -1
View File
@@ -14,4 +14,5 @@ val result = avatars.getInitials(
width = 0, // (optional)
height = 0, // (optional)
background = "", // (optional)
)```
)
```
+2 -1
View File
@@ -14,4 +14,5 @@ val result = avatars.getQR(
size = 1, // (optional)
margin = 0, // (optional)
download = false, // (optional)
)```
)
```
@@ -37,4 +37,5 @@ val result = avatars.getScreenshot(
height = 600, // (optional)
quality = 85, // (optional)
output = ImageFormat.JPG, // (optional)
)```
)
```
@@ -24,4 +24,5 @@ val result = databases.createDocument(
),
permissions = listOf(Permission.read(Role.any())), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -20,4 +20,5 @@ val result = databases.createOperations(
"name" to "Walter O'Brien"
)
)), // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val databases = Databases(client)
val result = databases.createTransaction(
ttl = 60, // (optional)
)```
)
```
@@ -17,4 +17,5 @@ val result = databases.decrementDocumentAttribute(
value = 0, // (optional)
min = 0, // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -14,4 +14,5 @@ val result = databases.deleteDocument(
collectionId = "<COLLECTION_ID>",
documentId = "<DOCUMENT_ID>",
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val databases = Databases(client)
val result = databases.deleteTransaction(
transactionId = "<TRANSACTION_ID>",
)```
)
```
@@ -15,4 +15,5 @@ val result = databases.getDocument(
documentId = "<DOCUMENT_ID>",
queries = listOf(), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val databases = Databases(client)
val result = databases.getTransaction(
transactionId = "<TRANSACTION_ID>",
)```
)
```
@@ -17,4 +17,5 @@ val result = databases.incrementDocumentAttribute(
value = 0, // (optional)
max = 0, // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -15,4 +15,5 @@ val result = databases.listDocuments(
queries = listOf(), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
total = false, // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val databases = Databases(client)
val result = databases.listTransactions(
queries = listOf(), // (optional)
)```
)
```
@@ -24,4 +24,5 @@ val result = databases.updateDocument(
), // (optional)
permissions = listOf(Permission.read(Role.any())), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -13,4 +13,5 @@ val result = databases.updateTransaction(
transactionId = "<TRANSACTION_ID>",
commit = false, // (optional)
rollback = false, // (optional)
)```
)
```
@@ -24,4 +24,5 @@ val result = databases.upsertDocument(
), // (optional)
permissions = listOf(Permission.read(Role.any())), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -18,4 +18,5 @@ val result = functions.createExecution(
method = ExecutionMethod.GET, // (optional)
headers = mapOf( "a" to "b" ), // (optional)
scheduledAt = "<SCHEDULED_AT>", // (optional)
)```
)
```
@@ -12,4 +12,5 @@ val functions = Functions(client)
val result = functions.getExecution(
functionId = "<FUNCTION_ID>",
executionId = "<EXECUTION_ID>",
)```
)
```
@@ -13,4 +13,5 @@ val result = functions.listExecutions(
functionId = "<FUNCTION_ID>",
queries = listOf(), // (optional)
total = false, // (optional)
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val graphql = Graphql(client)
val result = graphql.mutation(
query = mapOf( "a" to "b" ),
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val graphql = Graphql(client)
val result = graphql.query(
query = mapOf( "a" to "b" ),
)```
)
```
@@ -13,4 +13,5 @@ val result = messaging.createSubscriber(
topicId = "<TOPIC_ID>",
subscriberId = "<SUBSCRIBER_ID>",
targetId = "<TARGET_ID>",
)```
)
```
@@ -12,4 +12,5 @@ val messaging = Messaging(client)
val result = messaging.deleteSubscriber(
topicId = "<TOPIC_ID>",
subscriberId = "<SUBSCRIBER_ID>",
)```
)
```
+2 -1
View File
@@ -17,4 +17,5 @@ val result = storage.createFile(
fileId = "<FILE_ID>",
file = InputFile.fromPath("file.png"),
permissions = listOf(Permission.read(Role.any())), // (optional)
)```
)
```
+2 -1
View File
@@ -12,4 +12,5 @@ val storage = Storage(client)
val result = storage.deleteFile(
bucketId = "<BUCKET_ID>",
fileId = "<FILE_ID>",
)```
)
```
@@ -13,4 +13,5 @@ val result = storage.getFileDownload(
bucketId = "<BUCKET_ID>",
fileId = "<FILE_ID>",
token = "<TOKEN>", // (optional)
)```
)
```
@@ -26,4 +26,5 @@ val result = storage.getFilePreview(
background = "", // (optional)
output = ImageFormat.JPG, // (optional)
token = "<TOKEN>", // (optional)
)```
)
```
@@ -13,4 +13,5 @@ val result = storage.getFileView(
bucketId = "<BUCKET_ID>",
fileId = "<FILE_ID>",
token = "<TOKEN>", // (optional)
)```
)
```
+2 -1
View File
@@ -12,4 +12,5 @@ val storage = Storage(client)
val result = storage.getFile(
bucketId = "<BUCKET_ID>",
fileId = "<FILE_ID>",
)```
)
```
+2 -1
View File
@@ -14,4 +14,5 @@ val result = storage.listFiles(
queries = listOf(), // (optional)
search = "<SEARCH>", // (optional)
total = false, // (optional)
)```
)
```
+2 -1
View File
@@ -16,4 +16,5 @@ val result = storage.updateFile(
fileId = "<FILE_ID>",
name = "<NAME>", // (optional)
permissions = listOf(Permission.read(Role.any())), // (optional)
)```
)
```
@@ -20,4 +20,5 @@ val result = tablesDB.createOperations(
"name" to "Walter O'Brien"
)
)), // (optional)
)```
)
```
+2 -1
View File
@@ -24,4 +24,5 @@ val result = tablesDB.createRow(
),
permissions = listOf(Permission.read(Role.any())), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val tablesDB = TablesDB(client)
val result = tablesDB.createTransaction(
ttl = 60, // (optional)
)```
)
```
@@ -17,4 +17,5 @@ val result = tablesDB.decrementRowColumn(
value = 0, // (optional)
min = 0, // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
+2 -1
View File
@@ -14,4 +14,5 @@ val result = tablesDB.deleteRow(
tableId = "<TABLE_ID>",
rowId = "<ROW_ID>",
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val tablesDB = TablesDB(client)
val result = tablesDB.deleteTransaction(
transactionId = "<TRANSACTION_ID>",
)```
)
```
+2 -1
View File
@@ -15,4 +15,5 @@ val result = tablesDB.getRow(
rowId = "<ROW_ID>",
queries = listOf(), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val tablesDB = TablesDB(client)
val result = tablesDB.getTransaction(
transactionId = "<TRANSACTION_ID>",
)```
)
```
@@ -17,4 +17,5 @@ val result = tablesDB.incrementRowColumn(
value = 0, // (optional)
max = 0, // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
+2 -1
View File
@@ -15,4 +15,5 @@ val result = tablesDB.listRows(
queries = listOf(), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
total = false, // (optional)
)```
)
```
@@ -11,4 +11,5 @@ val tablesDB = TablesDB(client)
val result = tablesDB.listTransactions(
queries = listOf(), // (optional)
)```
)
```
+2 -1
View File
@@ -24,4 +24,5 @@ val result = tablesDB.updateRow(
), // (optional)
permissions = listOf(Permission.read(Role.any())), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -13,4 +13,5 @@ val result = tablesDB.updateTransaction(
transactionId = "<TRANSACTION_ID>",
commit = false, // (optional)
rollback = false, // (optional)
)```
)
```
+2 -1
View File
@@ -24,4 +24,5 @@ val result = tablesDB.upsertRow(
), // (optional)
permissions = listOf(Permission.read(Role.any())), // (optional)
transactionId = "<TRANSACTION_ID>", // (optional)
)```
)
```
@@ -17,4 +17,5 @@ val result = teams.createMembership(
phone = "+12065550100", // (optional)
url = "https://example.com", // (optional)
name = "<NAME>", // (optional)
)```
)
```
+2 -1
View File
@@ -13,4 +13,5 @@ val result = teams.create(
teamId = "<TEAM_ID>",
name = "<NAME>",
roles = listOf(), // (optional)
)```
)
```
@@ -12,4 +12,5 @@ val teams = Teams(client)
val result = teams.deleteMembership(
teamId = "<TEAM_ID>",
membershipId = "<MEMBERSHIP_ID>",
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val teams = Teams(client)
val result = teams.delete(
teamId = "<TEAM_ID>",
)```
)
```
+2 -1
View File
@@ -12,4 +12,5 @@ val teams = Teams(client)
val result = teams.getMembership(
teamId = "<TEAM_ID>",
membershipId = "<MEMBERSHIP_ID>",
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val teams = Teams(client)
val result = teams.getPrefs(
teamId = "<TEAM_ID>",
)```
)
```
+2 -1
View File
@@ -11,4 +11,5 @@ val teams = Teams(client)
val result = teams.get(
teamId = "<TEAM_ID>",
)```
)
```
@@ -14,4 +14,5 @@ val result = teams.listMemberships(
queries = listOf(), // (optional)
search = "<SEARCH>", // (optional)
total = false, // (optional)
)```
)
```
+2 -1
View File
@@ -13,4 +13,5 @@ val result = teams.list(
queries = listOf(), // (optional)
search = "<SEARCH>", // (optional)
total = false, // (optional)
)```
)
```
@@ -14,4 +14,5 @@ val result = teams.updateMembershipStatus(
membershipId = "<MEMBERSHIP_ID>",
userId = "<USER_ID>",
secret = "<SECRET>",
)```
)
```

Some files were not shown because too many files have changed in this diff Show More