From 2690250f55fcff2735f4ae634214e4038f8494e4 Mon Sep 17 00:00:00 2001 From: Damodar Lohani Date: Tue, 4 Jan 2022 18:18:27 +0545 Subject: [PATCH] updated param --- docs/sdks/android/GETTING_STARTED.md | 6 +++--- docs/sdks/dart/EXAMPLES.md | 4 ++-- docs/sdks/dart/GETTING_STARTED.md | 4 ++-- docs/sdks/deno/GETTING_STARTED.md | 6 +++--- docs/sdks/dotnet/GETTING_STARTED.md | 4 ++-- docs/sdks/flutter/EXAMPLES.md | 4 ++-- docs/sdks/flutter/GETTING_STARTED.md | 6 +++--- docs/sdks/kotlin/GETTING_STARTED.md | 6 +++--- docs/sdks/nodejs/GETTING_STARTED.md | 6 +++--- docs/sdks/php/GETTING_STARTED.md | 4 ++-- docs/sdks/python/GETTING_STARTED.md | 6 +++--- docs/sdks/ruby/GETTING_STARTED.md | 6 +++--- docs/sdks/swift-client/GETTING_STARTED.md | 6 +++--- docs/sdks/swift-server/GETTING_STARTED.md | 6 +++--- docs/sdks/web/GETTING_STARTED.md | 4 ++-- 15 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/sdks/android/GETTING_STARTED.md b/docs/sdks/android/GETTING_STARTED.md index 569ca2e92..0c00bf601 100644 --- a/docs/sdks/android/GETTING_STARTED.md +++ b/docs/sdks/android/GETTING_STARTED.md @@ -51,7 +51,7 @@ When trying to connect to Appwrite from an emulator or a mobile device, localhos // Register User val account = Account(client) val response = account.create( - "unique()", + "[USER_ID]", "email@example.com", "password" ) @@ -70,7 +70,7 @@ val client = Client(context) val account = Account(client) val response = account.create( - "unique()", + "[USER_ID]", "email@example.com", "password" ) @@ -81,7 +81,7 @@ The Appwrite Android SDK raises an `AppwriteException` object with `message`, `c ```kotlin try { - var response = account.create("unique()", "email@example.com", "password") + var response = account.create("[USER_ID]", "email@example.com", "password") Log.d("Appwrite response", response.body?.string()) } catch(e : AppwriteException) { Log.e("AppwriteException",e.message.toString()) diff --git a/docs/sdks/dart/EXAMPLES.md b/docs/sdks/dart/EXAMPLES.md index cd14497e0..961f82cf3 100644 --- a/docs/sdks/dart/EXAMPLES.md +++ b/docs/sdks/dart/EXAMPLES.md @@ -19,7 +19,7 @@ Create a new user: Users users = Users(client); Response result = await users.create( - userId: 'unique()', + userId: '[USER_ID]', email: 'email@example.com', password: 'password', ); @@ -44,7 +44,7 @@ Storage storage = Storage(client); MultipartFile file = MultipartFile.fromFile('./path-to-file/image.jpg', filename: 'image.jpg'); storage.createFile( - fileId: 'unique()', + fileId: '[FILE_ID]', file: file, read: ['role:all'], write: [] diff --git a/docs/sdks/dart/GETTING_STARTED.md b/docs/sdks/dart/GETTING_STARTED.md index d78fc7a95..dd1dd3918 100644 --- a/docs/sdks/dart/GETTING_STARTED.md +++ b/docs/sdks/dart/GETTING_STARTED.md @@ -16,7 +16,7 @@ void main() async { Users users = Users(client); try { - final response = await users.create(userId: 'unique()', email: ‘email@example.com’,password: ‘password’, name: ‘name’); + final response = await users.create(userId: '[USER_ID]', email: ‘email@example.com’,password: ‘password’, name: ‘name’); print(response.data); } on AppwriteException catch(e) { print(e.message); @@ -31,7 +31,7 @@ The Appwrite Dart SDK raises `AppwriteException` object with `message`, `code` a Users users = Users(client); try { - final response = await users.create(userId: 'unique()', email: ‘email@example.com’,password: ‘password’, name: ‘name’); + final response = await users.create(userId: '[USER_ID]', email: ‘email@example.com’,password: ‘password’, name: ‘name’); print(response.data); } on AppwriteException catch(e) { //show message to user or do other operation based on error as required diff --git a/docs/sdks/deno/GETTING_STARTED.md b/docs/sdks/deno/GETTING_STARTED.md index dca06a58e..08c9eb461 100644 --- a/docs/sdks/deno/GETTING_STARTED.md +++ b/docs/sdks/deno/GETTING_STARTED.md @@ -21,7 +21,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo ```typescript let users = new sdk.Users(client); -let response = await users.create('unique()', 'email@example.com', 'password'); +let response = await users.create('[USER_ID]', 'email@example.com', 'password'); console.log(response); ``` @@ -39,7 +39,7 @@ client .setSelfSigned() // Use only on dev mode with a self-signed SSL cert ; -let response = await users.create('unique()', 'email@example.com', 'password'); +let response = await users.create('[USER_ID]', 'email@example.com', 'password'); console.log(response); ``` @@ -50,7 +50,7 @@ The Appwrite Deno SDK raises `AppwriteException` object with `message`, `code` a let users = new sdk.Users(client); try { - let response = await users.create('unique()', 'email@example.com', 'password'); + let response = await users.create('[USER_ID]', 'email@example.com', 'password'); } catch(e) { console.log(e.message); } diff --git a/docs/sdks/dotnet/GETTING_STARTED.md b/docs/sdks/dotnet/GETTING_STARTED.md index 1633a48ed..cffbce207 100644 --- a/docs/sdks/dotnet/GETTING_STARTED.md +++ b/docs/sdks/dotnet/GETTING_STARTED.md @@ -20,7 +20,7 @@ static async Task Main(string[] args) var users = Users(client); try { - var request = await users.create('unique()', 'email@example.com', 'password', 'name'); + var request = await users.create('[USER_ID]', 'email@example.com', 'password', 'name'); var response = await request.Content.ReadAsStringAsync(); Console.WriteLine(response); } catch (AppwriteException e) { @@ -36,7 +36,7 @@ The Appwrite .NET SDK raises `AppwriteException` object with `message`, `code` a var users = Users(client); try { - var request = await users.create('unique()', 'email@example.com', 'password', 'name'); + var request = await users.create('[USER_ID]', 'email@example.com', 'password', 'name'); var response = await request.Content.ReadAsStringAsync(); Console.WriteLine(response); } catch (AppwriteException e) { diff --git a/docs/sdks/flutter/EXAMPLES.md b/docs/sdks/flutter/EXAMPLES.md index edddbfbe9..2d468db88 100644 --- a/docs/sdks/flutter/EXAMPLES.md +++ b/docs/sdks/flutter/EXAMPLES.md @@ -18,7 +18,7 @@ Create a new user and session: ```dart Account account = Account(client); -Response user = await account.create(userId: 'unique()', email: 'me@appwrite.io', password: 'password', name: 'My Name'); +Response user = await account.create(userId: '[USER_ID]', email: 'me@appwrite.io', password: 'password', name: 'My Name'); Response session = await account.createSession(email: 'me@appwrite.io', password: 'password'); @@ -40,7 +40,7 @@ Storage storage = Storage(client); MultipartFile file = MultipartFile.fromFile('./path-to-file/image.jpg', filename: 'image.jpg'); storage.createFile( - fileId: 'unique()', + fileId: '[FILE_ID]', file: file, read: ['role:all'], write: [] diff --git a/docs/sdks/flutter/GETTING_STARTED.md b/docs/sdks/flutter/GETTING_STARTED.md index 15a64bd8c..78fa4f93b 100644 --- a/docs/sdks/flutter/GETTING_STARTED.md +++ b/docs/sdks/flutter/GETTING_STARTED.md @@ -100,7 +100,7 @@ When trying to connect to Appwrite from an emulator or a mobile device, localhos Account account = Account(client); Response user = await account .create( - userId: 'unique()', + userId: '[USER_ID]', email: 'me@appwrite.io', password: 'password', name: 'My Name' @@ -128,7 +128,7 @@ void main() { Response user = await account .create( - userId: 'unique()', + userId: '[USER_ID]', email: 'me@appwrite.io', password: 'password', name: 'My Name' @@ -143,7 +143,7 @@ The Appwrite Flutter SDK raises `AppwriteException` object with `message`, `code Users users = Users(client); try { - final response = await users.create(userId: 'unique()', email: ‘email@example.com’,password: ‘password’, name: ‘name’); + final response = await users.create(userId: '[USER_ID]', email: ‘email@example.com’,password: ‘password’, name: ‘name’); print(response.data); } on AppwriteException catch(e) { //show message to user or do other operation based on error as required diff --git a/docs/sdks/kotlin/GETTING_STARTED.md b/docs/sdks/kotlin/GETTING_STARTED.md index cb839571d..be4da1a09 100644 --- a/docs/sdks/kotlin/GETTING_STARTED.md +++ b/docs/sdks/kotlin/GETTING_STARTED.md @@ -24,7 +24,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo ```kotlin val users = Users(client) val response = users.create( - user = "unique()", + user = "[USER_ID]", email = "email@example.com", password = "password", ) @@ -46,7 +46,7 @@ suspend fun main() { val users = Users(client) val response = users.create( - user = "unique()", + user = "[USER_ID]", email = "email@example.com", password = "password", ) @@ -66,7 +66,7 @@ suspend fun main() { val users = Users(client) try { val response = users.create( - user = "unique()", + user = "[USER_ID]", email = "email@example.com", password = "password", ) diff --git a/docs/sdks/nodejs/GETTING_STARTED.md b/docs/sdks/nodejs/GETTING_STARTED.md index 95c125048..7db328847 100644 --- a/docs/sdks/nodejs/GETTING_STARTED.md +++ b/docs/sdks/nodejs/GETTING_STARTED.md @@ -22,7 +22,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo ```js let users = new sdk.Users(client); -let promise = users.create('unique()', 'email@example.com', 'password'); +let promise = users.create('[USER_ID]', 'email@example.com', 'password'); promise.then(function (response) { console.log(response); @@ -45,7 +45,7 @@ client ; let users = new sdk.Users(client); -let promise = users.create('unique()', 'email@example.com', 'password'); +let promise = users.create('[USER_ID]', 'email@example.com', 'password'); promise.then(function (response) { console.log(response); @@ -61,7 +61,7 @@ The Appwrite Node SDK raises `AppwriteException` object with `message`, `code` a let users = new sdk.Users(client); try { - let res = await users.create('unique()', 'email@example.com', 'password'); + let res = await users.create('[USER_ID]', 'email@example.com', 'password'); } catch(e) { console.log(e.message); } diff --git a/docs/sdks/php/GETTING_STARTED.md b/docs/sdks/php/GETTING_STARTED.md index 1fe843200..0dcb7f247 100644 --- a/docs/sdks/php/GETTING_STARTED.md +++ b/docs/sdks/php/GETTING_STARTED.md @@ -39,7 +39,7 @@ $client $users = new Users($client); -$result = $users->create('unique()', 'email@example.com', 'password'); +$result = $users->create('[USER_ID]', 'email@example.com', 'password'); ``` ### Error Handling @@ -48,7 +48,7 @@ The Appwrite PHP SDK raises `AppwriteException` object with `message`, `code` an ```php $users = new Users($client); try { - $result = $users->create('unique()', 'email@example.com', 'password'); + $result = $users->create('[USER_ID]', 'email@example.com', 'password'); } catch(AppwriteException $error) { echo $error->message; } diff --git a/docs/sdks/python/GETTING_STARTED.md b/docs/sdks/python/GETTING_STARTED.md index e5fcac1b3..4473088b3 100644 --- a/docs/sdks/python/GETTING_STARTED.md +++ b/docs/sdks/python/GETTING_STARTED.md @@ -23,7 +23,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo ```python users = Users(client) -result = users.create('unique()', 'email@example.com', 'password') +result = users.create('[USER_ID]', 'email@example.com', 'password') ``` ### Full Example @@ -42,7 +42,7 @@ client = Client() users = Users(client) -result = users.create('unique()', 'email@example.com', 'password') +result = users.create('[USER_ID]', 'email@example.com', 'password') ``` ### Error Handling @@ -51,7 +51,7 @@ The Appwrite Python SDK raises `AppwriteException` object with `message`, `code` ```python users = Users(client) try: - result = users.create('unique()', 'email@example.com', 'password') + result = users.create('[USER_ID]', 'email@example.com', 'password') except AppwriteException as e: print(e.message) ``` diff --git a/docs/sdks/ruby/GETTING_STARTED.md b/docs/sdks/ruby/GETTING_STARTED.md index 85eea0e0d..ff714c103 100644 --- a/docs/sdks/ruby/GETTING_STARTED.md +++ b/docs/sdks/ruby/GETTING_STARTED.md @@ -22,7 +22,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo ```ruby users = Appwrite::Users.new(client); -result = users.create(userId: 'unique()', email: 'email@example.com', password: 'password'); +result = users.create(userId: '[USER_ID]', email: 'email@example.com', password: 'password'); ``` ### Full Example @@ -40,7 +40,7 @@ client users = Appwrite::Users.new(client); -result = users.create(userId: 'unique()', email: 'email@example.com', password: 'password'); +result = users.create(userId: '[USER_ID]', email: 'email@example.com', password: 'password'); ``` ### Error Handling @@ -50,7 +50,7 @@ The Appwrite Ruby SDK raises `Appwrite::Exception` object with `message`, `code` users = Appwrite::Users.new(client); begin - result = users.create(userId: 'unique()', email: 'email@example.com', password: 'password'); + result = users.create(userId: '[USER_ID]', email: 'email@example.com', password: 'password'); rescue Appwrite::Exception => error puts error.message end diff --git a/docs/sdks/swift-client/GETTING_STARTED.md b/docs/sdks/swift-client/GETTING_STARTED.md index 6ea0b5514..51e5a5bc8 100644 --- a/docs/sdks/swift-client/GETTING_STARTED.md +++ b/docs/sdks/swift-client/GETTING_STARTED.md @@ -72,7 +72,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo ```swift let users = Users(client: client) -users.create(userId: "unique()", email: "email@example.com", password: "password") { result in +users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in switch result { case .failure(let error): print(error.message) case .success(let user): print(String(describing: user)) @@ -92,7 +92,7 @@ func main() { .setSelfSigned() // Use only on dev mode with a self-signed SSL cert let users = Users(client: client) - users.create(userId: "unique()", email: "email@example.com", password: "password") { result in + users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in switch result { case .failure(let error): print(error.message) case .success(let user): print(String(describing: user)) @@ -111,7 +111,7 @@ import Appwrite func main() { let users = Users(client: client) - users.create(userId: "unique()", email: "email@example.com", password: "password") { result in + users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in switch result { case .failure(let error): print(error.message) diff --git a/docs/sdks/swift-server/GETTING_STARTED.md b/docs/sdks/swift-server/GETTING_STARTED.md index 0cb514124..c27fbb34a 100644 --- a/docs/sdks/swift-server/GETTING_STARTED.md +++ b/docs/sdks/swift-server/GETTING_STARTED.md @@ -22,7 +22,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo ```swift let users = Users(client: client) -users.create(userId: "unique()", email: "email@example.com", password: "password") { result in +users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in switch result { case .failure(let error): print(error.message) case .success(let user): print(String(describing: user)) @@ -43,7 +43,7 @@ func main() { .setSelfSigned() // Use only on dev mode with a self-signed SSL cert let users = Users(client: client) - users.create(userId: "unique()", email: "email@example.com", password: "password") { result in + users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in switch result { case .failure(let error): print(error.message) case .success(let user): print(String(describing: user)) @@ -62,7 +62,7 @@ import Appwrite func main() { let users = Users(client: client) - users.create(userId: "unique()", email: "email@example.com", password: "password") { result in + users.create(userId: "[USER_ID]", email: "email@example.com", password: "password") { result in switch result { case .failure(let error): print(error.message) diff --git a/docs/sdks/web/GETTING_STARTED.md b/docs/sdks/web/GETTING_STARTED.md index f51f88620..6f34a3dda 100644 --- a/docs/sdks/web/GETTING_STARTED.md +++ b/docs/sdks/web/GETTING_STARTED.md @@ -23,7 +23,7 @@ Once your SDK object is set, access any of the Appwrite services and choose any ```js // Register User -sdk.account.create('unique()', 'me@example.com', 'password', 'Jane Doe') +sdk.account.create('[USER_ID]', 'me@example.com', 'password', 'Jane Doe') .then(function (response) { console.log(response); }, function (error) { @@ -43,7 +43,7 @@ sdk ; // Register User -sdk.account.create('unique()', 'me@example.com', 'password', 'Jane Doe') +sdk.account.create('[USER_ID]', 'me@example.com', 'password', 'Jane Doe') .then(function (response) { console.log(response); }, function (error) {