You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use width, height and quality arguments to change the output settings.When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
23
+
* You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
24
24
*
25
25
* @param code Browser Code.
26
26
* @param width Image width. Pass an integer between 0 to 2000. Defaults to 100.
@@ -54,7 +54,7 @@ class Avatars : Service {
54
54
55
55
56
56
/**
57
-
* Get Credit Card Icon
57
+
* Get credit card icon
58
58
*
59
59
* The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
60
60
*
@@ -90,7 +90,7 @@ class Avatars : Service {
90
90
91
91
92
92
/**
93
-
* Get Favicon
93
+
* Get favicon
94
94
*
95
95
* Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.
96
96
*
@@ -116,9 +116,9 @@ class Avatars : Service {
116
116
117
117
118
118
/**
119
-
* Get Country Flag
119
+
* Get country flag
120
120
*
121
-
* You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) standard.When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
121
+
* You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
122
122
*
123
123
* @param code Country Code. ISO Alpha-2 country code format.
124
124
* @param width Image width. Pass an integer between 0 to 2000. Defaults to 100.
@@ -152,7 +152,7 @@ class Avatars : Service {
152
152
153
153
154
154
/**
155
-
* Get Image from URL
155
+
* Get image from URL
156
156
*
157
157
* Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.
158
158
*
@@ -185,7 +185,7 @@ class Avatars : Service {
185
185
186
186
187
187
/**
188
-
* Get User Initials
188
+
* Get user initials
189
189
*
190
190
* Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
191
191
*
@@ -221,7 +221,7 @@ class Avatars : Service {
221
221
222
222
223
223
/**
224
-
* Get QR Code
224
+
* Get QR code
225
225
*
226
226
* Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
22
22
*
@@ -56,7 +56,7 @@ class Databases : Service {
56
56
}
57
57
58
58
/**
59
-
* List Documents
59
+
* List documents
60
60
*
61
61
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
62
62
*
@@ -79,15 +79,15 @@ class Databases : Service {
79
79
)
80
80
81
81
/**
82
-
* Create Document
82
+
* Create document
83
83
*
84
-
* Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](/docs/server/databases#databasesCreateCollection) API or directly from your database console.
84
+
* Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
85
85
*
86
86
* @param databaseId Database ID.
87
87
* @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.
88
88
* @param documentId Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. 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.
89
89
* @param data Document data as JSON object.
90
-
* @param permissions An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](/docs/permissions).
90
+
* @param permissions An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
91
91
* @return [io.appwrite.models.Document<T>]
92
92
*/
93
93
@JvmOverloads
@@ -125,15 +125,15 @@ class Databases : Service {
125
125
}
126
126
127
127
/**
128
-
* Create Document
128
+
* Create document
129
129
*
130
-
* Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](/docs/server/databases#databasesCreateCollection) API or directly from your database console.
130
+
* Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
131
131
*
132
132
* @param databaseId Database ID.
133
133
* @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.
134
134
* @param documentId Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. 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.
135
135
* @param data Document data as JSON object.
136
-
* @param permissions An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](/docs/permissions).
136
+
* @param permissions An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
137
137
* @return [io.appwrite.models.Document<T>]
138
138
*/
139
139
@JvmOverloads
@@ -154,7 +154,7 @@ class Databases : Service {
154
154
)
155
155
156
156
/**
157
-
* Get Document
157
+
* Get document
158
158
*
159
159
* Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
160
160
*
@@ -197,7 +197,7 @@ class Databases : Service {
197
197
}
198
198
199
199
/**
200
-
* Get Document
200
+
* Get document
201
201
*
202
202
* Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
203
203
*
@@ -223,15 +223,15 @@ class Databases : Service {
223
223
)
224
224
225
225
/**
226
-
* Update Document
226
+
* Update document
227
227
*
228
228
* Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
229
229
*
230
230
* @param databaseId Database ID.
231
231
* @param collectionId Collection ID.
232
232
* @param documentId Document ID.
233
233
* @param data Document data as JSON object. Include only attribute and value pairs to be updated.
234
-
* @param permissions An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](/docs/permissions).
234
+
* @param permissions An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
235
235
* @return [io.appwrite.models.Document<T>]
236
236
*/
237
237
@JvmOverloads
@@ -269,15 +269,15 @@ class Databases : Service {
269
269
}
270
270
271
271
/**
272
-
* Update Document
272
+
* Update document
273
273
*
274
274
* Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
275
275
*
276
276
* @param databaseId Database ID.
277
277
* @param collectionId Collection ID.
278
278
* @param documentId Document ID.
279
279
* @param data Document data as JSON object. Include only attribute and value pairs to be updated.
280
-
* @param permissions An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](/docs/permissions).
280
+
* @param permissions An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
* Get a list of all the current user function execution logs. You can use the query params to filter your results.
22
22
*
@@ -56,7 +56,7 @@ class Functions : Service {
56
56
57
57
58
58
/**
59
-
* Create Execution
59
+
* Create execution
60
60
*
61
61
* Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.
0 commit comments