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

Release candidate for 1.5.x

Browse Source
This commit is contained in:
Jake Barnby
2024-02-25 00:29:30 +13:00
parent 319aae7d3f
commit 4adba1f6ec
70 changed files with 294 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/examples/account/create2f-a-challenge.md → docs/examples/account/create-challenge.md
+1 -1
View File
@@ -6,7 +6,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.create2FAChallenge(
Future result = account.createChallenge(
factor: AuthenticationFactor.totp,
);
docs/examples/account/create-email-token.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.createEmailToken(
userId: '[USER_ID]',
userId: '<USER_ID>',
email: 'email@example.com',
phrase: false, // (optional)
);
docs/examples/account/create-magic-u-r-l-token.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.createMagicURLToken(
userId: '[USER_ID]',
userId: '<USER_ID>',
email: 'email@example.com',
url: 'https://example.com', // (optional)
phrase: false, // (optional)
docs/examples/account/create-o-auth2session.md
-1
View File
@@ -10,7 +10,6 @@ Future result = account.createOAuth2Session(
provider: OAuthProvider.amazon,
success: 'https://example.com', // (optional)
failure: 'https://example.com', // (optional)
token: false, // (optional)
scopes: [], // (optional)
);
docs/examples/account/create-o-auth2token.md
+21
View File
@@ -0,0 +1,21 @@
import 'package:appwrite/appwrite.dart';
Client client = Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('5df5acd0d48c2'); // Your project ID
Account account = Account(client);
Future result = account.createOAuth2Token(
provider: OAuthProvider.amazon,
success: 'https://example.com', // (optional)
failure: 'https://example.com', // (optional)
scopes: [], // (optional)
);
result.then((response) {
print(response);
}).catchError((error) {
print(error.response);
});
docs/examples/account/create-phone-token.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.createPhoneToken(
userId: '[USER_ID]',
userId: '<USER_ID>',
phone: '+12065550100',
);
docs/examples/account/create-push-target.md
+3 -3
View File
@@ -7,9 +7,9 @@ Client client = Client()
Account account = Account(client);
Future result = account.createPushTarget(
targetId: '[TARGET_ID]',
identifier: '[IDENTIFIER]',
providerId: '[PROVIDER_ID]', // (optional)
targetId: '<TARGET_ID>',
identifier: '<IDENTIFIER>',
providerId: '<PROVIDER_ID>', // (optional)
);
result.then((response) {
docs/examples/account/create-session.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Account account = Account(client);
Future result = account.createSession(
userId: '[USER_ID]',
secret: '[SECRET]',
userId: '<USER_ID>',
secret: '<SECRET>',
);
result.then((response) {
docs/examples/account/create.md
+2 -2
View File
@@ -7,10 +7,10 @@ Client client = Client()
Account account = Account(client);
Future result = account.create(
userId: '[USER_ID]',
userId: '<USER_ID>',
email: 'email@example.com',
password: '',
name: '[NAME]', // (optional)
name: '<NAME>', // (optional)
);
result.then((response) {
docs/examples/account/delete-authenticator.md
+1 -1
View File
@@ -8,7 +8,7 @@ Account account = Account(client);
Future result = account.deleteAuthenticator(
type: AuthenticatorType.totp,
otp: '[OTP]',
otp: '<OTP>',
);
result.then((response) {
docs/examples/account/delete-identity.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.deleteIdentity(
identityId: '[IDENTITY_ID]',
identityId: '<IDENTITY_ID>',
);
result.then((response) {
docs/examples/account/delete-push-target.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.deletePushTarget(
targetId: '[TARGET_ID]',
targetId: '<TARGET_ID>',
);
result.then((response) {
docs/examples/account/delete-session.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.deleteSession(
sessionId: '[SESSION_ID]',
sessionId: '<SESSION_ID>',
);
result.then((response) {
docs/examples/account/get-session.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.getSession(
sessionId: '[SESSION_ID]',
sessionId: '<SESSION_ID>',
);
result.then((response) {
docs/examples/account/update-challenge.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Account account = Account(client);
Future result = account.updateChallenge(
challengeId: '[CHALLENGE_ID]',
otp: '[OTP]',
challengeId: '<CHALLENGE_ID>',
otp: '<OTP>',
);
result.then((response) {
docs/examples/account/update-magic-u-r-l-session.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Account account = Account(client);
Future result = account.updateMagicURLSession(
userId: '[USER_ID]',
secret: '[SECRET]',
userId: '<USER_ID>',
secret: '<SECRET>',
);
result.then((response) {
docs/examples/account/update-name.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.updateName(
name: '[NAME]',
name: '<NAME>',
);
result.then((response) {
docs/examples/account/update-phone-verification.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Account account = Account(client);
Future result = account.updatePhoneVerification(
userId: '[USER_ID]',
secret: '[SECRET]',
userId: '<USER_ID>',
secret: '<SECRET>',
);
result.then((response) {
docs/examples/account/update-push-target.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Account account = Account(client);
Future result = account.updatePushTarget(
targetId: '[TARGET_ID]',
identifier: '[IDENTIFIER]',
targetId: '<TARGET_ID>',
identifier: '<IDENTIFIER>',
);
result.then((response) {
docs/examples/account/update-recovery.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Account account = Account(client);
Future result = account.updateRecovery(
userId: '[USER_ID]',
secret: '[SECRET]',
userId: '<USER_ID>',
secret: '<SECRET>',
password: '',
);
docs/examples/account/update-session.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Account account = Account(client);
Future result = account.updateSession(
sessionId: '[SESSION_ID]',
sessionId: '<SESSION_ID>',
);
result.then((response) {
docs/examples/account/update-verification.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Account account = Account(client);
Future result = account.updateVerification(
userId: '[USER_ID]',
secret: '[SECRET]',
userId: '<USER_ID>',
secret: '<SECRET>',
);
result.then((response) {
docs/examples/account/verify-authenticator.md
+1 -1
View File
@@ -8,7 +8,7 @@ Account account = Account(client);
Future result = account.verifyAuthenticator(
type: AuthenticatorType.totp,
otp: '[OTP]',
otp: '<OTP>',
);
result.then((response) {
docs/examples/avatars/get-initials.md
+2 -2
View File
@@ -8,7 +8,7 @@ Avatars avatars = Avatars(client);
// Downloading file
Future result = avatars.getInitials(
name: '[NAME]', // (optional)
name: '<NAME>', // (optional)
width: 0, // (optional)
height: 0, // (optional)
background: '', // (optional)
@@ -22,7 +22,7 @@ Future result = avatars.getInitials(
// Displaying image preview
FutureBuilder(
future: avatars.getInitials(
name:'[NAME]' , // (optional)
name:'<NAME>' , // (optional)
width:0 , // (optional)
height:0 , // (optional)
background:'' , // (optional)
docs/examples/avatars/get-q-r.md
+2 -2
View File
@@ -8,7 +8,7 @@ Avatars avatars = Avatars(client);
// Downloading file
Future result = avatars.getQR(
text: '[TEXT]',
text: '<TEXT>',
size: 1, // (optional)
margin: 0, // (optional)
download: false, // (optional)
@@ -22,7 +22,7 @@ Future result = avatars.getQR(
// Displaying image preview
FutureBuilder(
future: avatars.getQR(
text:'[TEXT]' ,
text:'<TEXT>' ,
size:1 , // (optional)
margin:0 , // (optional)
download:false , // (optional)
docs/examples/databases/create-document.md
+3 -3
View File
@@ -7,9 +7,9 @@ Client client = Client()
Databases databases = Databases(client);
Future result = databases.createDocument(
databaseId: '[DATABASE_ID]',
collectionId: '[COLLECTION_ID]',
documentId: '[DOCUMENT_ID]',
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
data: {},
permissions: ["read("any")"], // (optional)
);
docs/examples/databases/delete-document.md
+3 -3
View File
@@ -7,9 +7,9 @@ Client client = Client()
Databases databases = Databases(client);
Future result = databases.deleteDocument(
databaseId: '[DATABASE_ID]',
collectionId: '[COLLECTION_ID]',
documentId: '[DOCUMENT_ID]',
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
);
result.then((response) {
docs/examples/databases/get-document.md
+3 -3
View File
@@ -7,9 +7,9 @@ Client client = Client()
Databases databases = Databases(client);
Future result = databases.getDocument(
databaseId: '[DATABASE_ID]',
collectionId: '[COLLECTION_ID]',
documentId: '[DOCUMENT_ID]',
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
queries: [], // (optional)
);
docs/examples/databases/list-documents.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Databases databases = Databases(client);
Future result = databases.listDocuments(
databaseId: '[DATABASE_ID]',
collectionId: '[COLLECTION_ID]',
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
queries: [], // (optional)
);
docs/examples/databases/update-document.md
+3 -3
View File
@@ -7,9 +7,9 @@ Client client = Client()
Databases databases = Databases(client);
Future result = databases.updateDocument(
databaseId: '[DATABASE_ID]',
collectionId: '[COLLECTION_ID]',
documentId: '[DOCUMENT_ID]',
databaseId: '<DATABASE_ID>',
collectionId: '<COLLECTION_ID>',
documentId: '<DOCUMENT_ID>',
data: {}, // (optional)
permissions: ["read("any")"], // (optional)
);
docs/examples/functions/create-execution.md
+3 -3
View File
@@ -7,10 +7,10 @@ Client client = Client()
Functions functions = Functions(client);
Future result = functions.createExecution(
functionId: '[FUNCTION_ID]',
body: '[BODY]', // (optional)
functionId: '<FUNCTION_ID>',
body: '<BODY>', // (optional)
xasync: false, // (optional)
path: '[PATH]', // (optional)
path: '<PATH>', // (optional)
method: ExecutionMethod.gET, // (optional)
headers: {}, // (optional)
);
docs/examples/functions/get-execution.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Functions functions = Functions(client);
Future result = functions.getExecution(
functionId: '[FUNCTION_ID]',
executionId: '[EXECUTION_ID]',
functionId: '<FUNCTION_ID>',
executionId: '<EXECUTION_ID>',
);
result.then((response) {
docs/examples/functions/list-executions.md
+2 -2
View File
@@ -7,9 +7,9 @@ Client client = Client()
Functions functions = Functions(client);
Future result = functions.listExecutions(
functionId: '[FUNCTION_ID]',
functionId: '<FUNCTION_ID>',
queries: [], // (optional)
search: '[SEARCH]', // (optional)
search: '<SEARCH>', // (optional)
);
result.then((response) {
docs/examples/messaging/create-subscriber.md
+3 -3
View File
@@ -7,9 +7,9 @@ Client client = Client()
Messaging messaging = Messaging(client);
Future result = messaging.createSubscriber(
topicId: '[TOPIC_ID]',
subscriberId: '[SUBSCRIBER_ID]',
targetId: '[TARGET_ID]',
topicId: '<TOPIC_ID>',
subscriberId: '<SUBSCRIBER_ID>',
targetId: '<TARGET_ID>',
);
result.then((response) {
docs/examples/messaging/delete-subscriber.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Messaging messaging = Messaging(client);
Future result = messaging.deleteSubscriber(
topicId: '[TOPIC_ID]',
subscriberId: '[SUBSCRIBER_ID]',
topicId: '<TOPIC_ID>',
subscriberId: '<SUBSCRIBER_ID>',
);
result.then((response) {
docs/examples/storage/create-file.md
+2 -2
View File
@@ -8,8 +8,8 @@ Client client = Client()
Storage storage = Storage(client);
Future result = storage.createFile(
bucketId: '[BUCKET_ID]',
fileId: '[FILE_ID]',
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
file: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'),
permissions: ["read("any")"], // (optional)
);
docs/examples/storage/delete-file.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Storage storage = Storage(client);
Future result = storage.deleteFile(
bucketId: '[BUCKET_ID]',
fileId: '[FILE_ID]',
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
);
result.then((response) {
docs/examples/storage/get-file-download.md
+4 -4
View File
@@ -8,8 +8,8 @@ Storage storage = Storage(client);
// Downloading file
Future result = storage.getFileDownload(
bucketId: '[BUCKET_ID]',
fileId: '[FILE_ID]',
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
).then((bytes) {
final file = File('path_to_file/filename.ext');
file.writeAsBytesSync(bytes)
@@ -20,8 +20,8 @@ Future result = storage.getFileDownload(
// Displaying image preview
FutureBuilder(
future: storage.getFileDownload(
bucketId:'[BUCKET_ID]' ,
fileId:'[FILE_ID]' ,
bucketId:'<BUCKET_ID>' ,
fileId:'<FILE_ID>' ,
), // Works for both public file and private file, for private files you need to be logged in
builder: (context, snapshot) {
return snapshot.hasData && snapshot.data != null
docs/examples/storage/get-file-preview.md
+4 -4
View File
@@ -8,8 +8,8 @@ Storage storage = Storage(client);
// Downloading file
Future result = storage.getFilePreview(
bucketId: '[BUCKET_ID]',
fileId: '[FILE_ID]',
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
width: 0, // (optional)
height: 0, // (optional)
gravity: ImageGravity.center, // (optional)
@@ -31,8 +31,8 @@ Future result = storage.getFilePreview(
// Displaying image preview
FutureBuilder(
future: storage.getFilePreview(
bucketId:'[BUCKET_ID]' ,
fileId:'[FILE_ID]' ,
bucketId:'<BUCKET_ID>' ,
fileId:'<FILE_ID>' ,
width:0 , // (optional)
height:0 , // (optional)
gravity: ImageGravity.center.value, // (optional)
docs/examples/storage/get-file-view.md
+4 -4
View File
@@ -8,8 +8,8 @@ Storage storage = Storage(client);
// Downloading file
Future result = storage.getFileView(
bucketId: '[BUCKET_ID]',
fileId: '[FILE_ID]',
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
).then((bytes) {
final file = File('path_to_file/filename.ext');
file.writeAsBytesSync(bytes)
@@ -20,8 +20,8 @@ Future result = storage.getFileView(
// Displaying image preview
FutureBuilder(
future: storage.getFileView(
bucketId:'[BUCKET_ID]' ,
fileId:'[FILE_ID]' ,
bucketId:'<BUCKET_ID>' ,
fileId:'<FILE_ID>' ,
), // Works for both public file and private file, for private files you need to be logged in
builder: (context, snapshot) {
return snapshot.hasData && snapshot.data != null
docs/examples/storage/get-file.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Storage storage = Storage(client);
Future result = storage.getFile(
bucketId: '[BUCKET_ID]',
fileId: '[FILE_ID]',
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
);
result.then((response) {
docs/examples/storage/list-files.md
+2 -2
View File
@@ -7,9 +7,9 @@ Client client = Client()
Storage storage = Storage(client);
Future result = storage.listFiles(
bucketId: '[BUCKET_ID]',
bucketId: '<BUCKET_ID>',
queries: [], // (optional)
search: '[SEARCH]', // (optional)
search: '<SEARCH>', // (optional)
);
result.then((response) {
docs/examples/storage/update-file.md
+3 -3
View File
@@ -7,9 +7,9 @@ Client client = Client()
Storage storage = Storage(client);
Future result = storage.updateFile(
bucketId: '[BUCKET_ID]',
fileId: '[FILE_ID]',
name: '[NAME]', // (optional)
bucketId: '<BUCKET_ID>',
fileId: '<FILE_ID>',
name: '<NAME>', // (optional)
permissions: ["read("any")"], // (optional)
);
docs/examples/teams/create-membership.md
+3 -3
View File
@@ -7,13 +7,13 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.createMembership(
teamId: '[TEAM_ID]',
teamId: '<TEAM_ID>',
roles: [],
email: 'email@example.com', // (optional)
userId: '[USER_ID]', // (optional)
userId: '<USER_ID>', // (optional)
phone: '+12065550100', // (optional)
url: 'https://example.com', // (optional)
name: '[NAME]', // (optional)
name: '<NAME>', // (optional)
);
result.then((response) {
docs/examples/teams/create.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.create(
teamId: '[TEAM_ID]',
name: '[NAME]',
teamId: '<TEAM_ID>',
name: '<NAME>',
roles: [], // (optional)
);
docs/examples/teams/delete-membership.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.deleteMembership(
teamId: '[TEAM_ID]',
membershipId: '[MEMBERSHIP_ID]',
teamId: '<TEAM_ID>',
membershipId: '<MEMBERSHIP_ID>',
);
result.then((response) {
docs/examples/teams/delete.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.delete(
teamId: '[TEAM_ID]',
teamId: '<TEAM_ID>',
);
result.then((response) {
docs/examples/teams/get-membership.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.getMembership(
teamId: '[TEAM_ID]',
membershipId: '[MEMBERSHIP_ID]',
teamId: '<TEAM_ID>',
membershipId: '<MEMBERSHIP_ID>',
);
result.then((response) {
docs/examples/teams/get-prefs.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.getPrefs(
teamId: '[TEAM_ID]',
teamId: '<TEAM_ID>',
);
result.then((response) {
docs/examples/teams/get.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.get(
teamId: '[TEAM_ID]',
teamId: '<TEAM_ID>',
);
result.then((response) {
docs/examples/teams/list-memberships.md
+2 -2
View File
@@ -7,9 +7,9 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.listMemberships(
teamId: '[TEAM_ID]',
teamId: '<TEAM_ID>',
queries: [], // (optional)
search: '[SEARCH]', // (optional)
search: '<SEARCH>', // (optional)
);
result.then((response) {
docs/examples/teams/list.md
+1 -1
View File
@@ -8,7 +8,7 @@ Teams teams = Teams(client);
Future result = teams.list(
queries: [], // (optional)
search: '[SEARCH]', // (optional)
search: '<SEARCH>', // (optional)
);
result.then((response) {
docs/examples/teams/update-membership-status.md
+4 -4
View File
@@ -7,10 +7,10 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.updateMembershipStatus(
teamId: '[TEAM_ID]',
membershipId: '[MEMBERSHIP_ID]',
userId: '[USER_ID]',
secret: '[SECRET]',
teamId: '<TEAM_ID>',
membershipId: '<MEMBERSHIP_ID>',
userId: '<USER_ID>',
secret: '<SECRET>',
);
result.then((response) {
docs/examples/teams/update-membership.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.updateMembership(
teamId: '[TEAM_ID]',
membershipId: '[MEMBERSHIP_ID]',
teamId: '<TEAM_ID>',
membershipId: '<MEMBERSHIP_ID>',
roles: [],
);
docs/examples/teams/update-name.md
+2 -2
View File
@@ -7,8 +7,8 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.updateName(
teamId: '[TEAM_ID]',
name: '[NAME]',
teamId: '<TEAM_ID>',
name: '<NAME>',
);
result.then((response) {
docs/examples/teams/update-prefs.md
+1 -1
View File
@@ -7,7 +7,7 @@ Client client = Client()
Teams teams = Teams(client);
Future result = teams.updatePrefs(
teamId: '[TEAM_ID]',
teamId: '<TEAM_ID>',
prefs: {},
);