@appwrite.io/console 2.0.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +2 -2
- package/dist/cjs/sdk.js +81 -15
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +77 -15
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +3838 -15
- package/docs/examples/account/update-payment-method.md +1 -1
- package/docs/examples/projects/update-labels.md +14 -0
- package/package.json +7 -1
- package/rollup.config.js +40 -24
- package/src/client.ts +49 -10
- package/src/models.ts +432 -424
- package/src/query.ts +14 -11
- package/src/services/account.ts +20 -20
- package/src/services/avatars.ts +117 -117
- package/src/services/backups.ts +18 -18
- package/src/services/console.ts +24 -24
- package/src/services/databases.ts +119 -119
- package/src/services/domains.ts +204 -204
- package/src/services/functions.ts +30 -30
- package/src/services/health.ts +146 -146
- package/src/services/messaging.ts +54 -54
- package/src/services/migrations.ts +36 -36
- package/src/services/organizations.ts +42 -42
- package/src/services/projects.ts +146 -83
- package/src/services/sites.ts +30 -30
- package/src/services/storage.ts +49 -49
- package/src/services/tables-db.ts +119 -119
- package/src/services/users.ts +39 -39
- package/types/client.d.ts +27 -1
- package/types/models.d.ts +432 -424
- package/types/query.d.ts +8 -8
- package/types/services/account.d.ts +11 -11
- package/types/services/avatars.d.ts +82 -82
- package/types/services/backups.d.ts +8 -8
- package/types/services/console.d.ts +14 -14
- package/types/services/databases.d.ts +70 -70
- package/types/services/domains.d.ts +104 -104
- package/types/services/functions.d.ts +15 -15
- package/types/services/health.d.ts +72 -72
- package/types/services/messaging.d.ts +24 -24
- package/types/services/migrations.d.ts +16 -16
- package/types/services/organizations.d.ts +22 -22
- package/types/services/projects.d.ts +60 -38
- package/types/services/sites.d.ts +15 -15
- package/types/services/storage.d.ts +34 -34
- package/types/services/tables-db.d.ts +70 -70
- package/types/services/users.d.ts +24 -24
package/src/query.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
import JSONbigModule from 'json-bigint';
|
|
2
|
+
const JSONbig = JSONbigModule({ useNativeBigInt: true });
|
|
3
|
+
|
|
4
|
+
type QueryTypesSingle = string | number | bigint | boolean;
|
|
5
|
+
export type QueryTypesList = string[] | number[] | bigint[] | boolean[] | Query[] | any[];
|
|
3
6
|
export type QueryTypes = QueryTypesSingle | QueryTypesList;
|
|
4
7
|
type AttributesTypes = string | string[];
|
|
5
8
|
|
|
@@ -41,7 +44,7 @@ export class Query {
|
|
|
41
44
|
* @returns {string}
|
|
42
45
|
*/
|
|
43
46
|
toString(): string {
|
|
44
|
-
return
|
|
47
|
+
return JSONbig.stringify({
|
|
45
48
|
method: this.method,
|
|
46
49
|
attribute: this.attribute,
|
|
47
50
|
values: this.values,
|
|
@@ -130,11 +133,11 @@ export class Query {
|
|
|
130
133
|
* Filter resources where attribute is between start and end (inclusive).
|
|
131
134
|
*
|
|
132
135
|
* @param {string} attribute
|
|
133
|
-
* @param {string | number} start
|
|
134
|
-
* @param {string | number} end
|
|
136
|
+
* @param {string | number | bigint} start
|
|
137
|
+
* @param {string | number | bigint} end
|
|
135
138
|
* @returns {string}
|
|
136
139
|
*/
|
|
137
|
-
static between = (attribute: string, start: string | number, end: string | number): string =>
|
|
140
|
+
static between = (attribute: string, start: string | number | bigint, end: string | number | bigint): string =>
|
|
138
141
|
new Query("between", attribute, [start, end] as QueryTypesList).toString();
|
|
139
142
|
|
|
140
143
|
/**
|
|
@@ -274,11 +277,11 @@ export class Query {
|
|
|
274
277
|
* Filter resources where attribute is not between start and end (exclusive).
|
|
275
278
|
*
|
|
276
279
|
* @param {string} attribute
|
|
277
|
-
* @param {string | number} start
|
|
278
|
-
* @param {string | number} end
|
|
280
|
+
* @param {string | number | bigint} start
|
|
281
|
+
* @param {string | number | bigint} end
|
|
279
282
|
* @returns {string}
|
|
280
283
|
*/
|
|
281
|
-
static notBetween = (attribute: string, start: string | number, end: string | number): string =>
|
|
284
|
+
static notBetween = (attribute: string, start: string | number | bigint, end: string | number | bigint): string =>
|
|
282
285
|
new Query("notBetween", attribute, [start, end] as QueryTypesList).toString();
|
|
283
286
|
|
|
284
287
|
/**
|
|
@@ -364,7 +367,7 @@ export class Query {
|
|
|
364
367
|
* @returns {string}
|
|
365
368
|
*/
|
|
366
369
|
static or = (queries: string[]) =>
|
|
367
|
-
new Query("or", undefined, queries.map((query) =>
|
|
370
|
+
new Query("or", undefined, queries.map((query) => JSONbig.parse(query))).toString();
|
|
368
371
|
|
|
369
372
|
/**
|
|
370
373
|
* Combine multiple queries using logical AND operator.
|
|
@@ -373,7 +376,7 @@ export class Query {
|
|
|
373
376
|
* @returns {string}
|
|
374
377
|
*/
|
|
375
378
|
static and = (queries: string[]) =>
|
|
376
|
-
new Query("and", undefined, queries.map((query) =>
|
|
379
|
+
new Query("and", undefined, queries.map((query) => JSONbig.parse(query))).toString();
|
|
377
380
|
|
|
378
381
|
/**
|
|
379
382
|
* Filter resources where attribute is at a specific distance from the given coordinates.
|
package/src/services/account.ts
CHANGED
|
@@ -784,30 +784,30 @@ export class Account {
|
|
|
784
784
|
/**
|
|
785
785
|
* Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.
|
|
786
786
|
*
|
|
787
|
-
* @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
787
|
+
* @param {number | bigint} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
788
788
|
* @throws {AppwriteException}
|
|
789
789
|
* @returns {Promise<Models.Jwt>}
|
|
790
790
|
*/
|
|
791
|
-
createJWT(params?: { duration?: number }): Promise<Models.Jwt>;
|
|
791
|
+
createJWT(params?: { duration?: number | bigint }): Promise<Models.Jwt>;
|
|
792
792
|
/**
|
|
793
793
|
* Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.
|
|
794
794
|
*
|
|
795
|
-
* @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
795
|
+
* @param {number | bigint} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
796
796
|
* @throws {AppwriteException}
|
|
797
797
|
* @returns {Promise<Models.Jwt>}
|
|
798
798
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
799
799
|
*/
|
|
800
|
-
createJWT(duration?: number): Promise<Models.Jwt>;
|
|
800
|
+
createJWT(duration?: number | bigint): Promise<Models.Jwt>;
|
|
801
801
|
createJWT(
|
|
802
|
-
paramsOrFirst?: { duration?: number } | number
|
|
802
|
+
paramsOrFirst?: { duration?: number | bigint } | number | bigint
|
|
803
803
|
): Promise<Models.Jwt> {
|
|
804
|
-
let params: { duration?: number };
|
|
804
|
+
let params: { duration?: number | bigint };
|
|
805
805
|
|
|
806
806
|
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
807
|
-
params = (paramsOrFirst || {}) as { duration?: number };
|
|
807
|
+
params = (paramsOrFirst || {}) as { duration?: number | bigint };
|
|
808
808
|
} else {
|
|
809
809
|
params = {
|
|
810
|
-
duration: paramsOrFirst as number
|
|
810
|
+
duration: paramsOrFirst as number | bigint
|
|
811
811
|
};
|
|
812
812
|
}
|
|
813
813
|
|
|
@@ -1968,38 +1968,38 @@ export class Account {
|
|
|
1968
1968
|
* Update a new payment method for the current user account.
|
|
1969
1969
|
*
|
|
1970
1970
|
* @param {string} params.paymentMethodId - Unique ID of payment method
|
|
1971
|
-
* @param {number} params.expiryMonth - Payment expiry month
|
|
1972
|
-
* @param {number} params.expiryYear - Expiry year
|
|
1971
|
+
* @param {number | bigint} params.expiryMonth - Payment expiry month
|
|
1972
|
+
* @param {number | bigint} params.expiryYear - Expiry year
|
|
1973
1973
|
* @param {string} params.state - State of the payment method country
|
|
1974
1974
|
* @throws {AppwriteException}
|
|
1975
1975
|
* @returns {Promise<Models.PaymentMethod>}
|
|
1976
1976
|
*/
|
|
1977
|
-
updatePaymentMethod(params: { paymentMethodId: string, expiryMonth: number, expiryYear: number, state?: string }): Promise<Models.PaymentMethod>;
|
|
1977
|
+
updatePaymentMethod(params: { paymentMethodId: string, expiryMonth: number | bigint, expiryYear: number | bigint, state?: string }): Promise<Models.PaymentMethod>;
|
|
1978
1978
|
/**
|
|
1979
1979
|
* Update a new payment method for the current user account.
|
|
1980
1980
|
*
|
|
1981
1981
|
* @param {string} paymentMethodId - Unique ID of payment method
|
|
1982
|
-
* @param {number} expiryMonth - Payment expiry month
|
|
1983
|
-
* @param {number} expiryYear - Expiry year
|
|
1982
|
+
* @param {number | bigint} expiryMonth - Payment expiry month
|
|
1983
|
+
* @param {number | bigint} expiryYear - Expiry year
|
|
1984
1984
|
* @param {string} state - State of the payment method country
|
|
1985
1985
|
* @throws {AppwriteException}
|
|
1986
1986
|
* @returns {Promise<Models.PaymentMethod>}
|
|
1987
1987
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1988
1988
|
*/
|
|
1989
|
-
updatePaymentMethod(paymentMethodId: string, expiryMonth: number, expiryYear: number, state?: string): Promise<Models.PaymentMethod>;
|
|
1989
|
+
updatePaymentMethod(paymentMethodId: string, expiryMonth: number | bigint, expiryYear: number | bigint, state?: string): Promise<Models.PaymentMethod>;
|
|
1990
1990
|
updatePaymentMethod(
|
|
1991
|
-
paramsOrFirst: { paymentMethodId: string, expiryMonth: number, expiryYear: number, state?: string } | string,
|
|
1992
|
-
...rest: [(number)?, (number)?, (string)?]
|
|
1991
|
+
paramsOrFirst: { paymentMethodId: string, expiryMonth: number | bigint, expiryYear: number | bigint, state?: string } | string,
|
|
1992
|
+
...rest: [(number | bigint)?, (number | bigint)?, (string)?]
|
|
1993
1993
|
): Promise<Models.PaymentMethod> {
|
|
1994
|
-
let params: { paymentMethodId: string, expiryMonth: number, expiryYear: number, state?: string };
|
|
1994
|
+
let params: { paymentMethodId: string, expiryMonth: number | bigint, expiryYear: number | bigint, state?: string };
|
|
1995
1995
|
|
|
1996
1996
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
1997
|
-
params = (paramsOrFirst || {}) as { paymentMethodId: string, expiryMonth: number, expiryYear: number, state?: string };
|
|
1997
|
+
params = (paramsOrFirst || {}) as { paymentMethodId: string, expiryMonth: number | bigint, expiryYear: number | bigint, state?: string };
|
|
1998
1998
|
} else {
|
|
1999
1999
|
params = {
|
|
2000
2000
|
paymentMethodId: paramsOrFirst as string,
|
|
2001
|
-
expiryMonth: rest[0] as number,
|
|
2002
|
-
expiryYear: rest[1] as number,
|
|
2001
|
+
expiryMonth: rest[0] as number | bigint,
|
|
2002
|
+
expiryYear: rest[1] as number | bigint,
|
|
2003
2003
|
state: rest[2] as string
|
|
2004
2004
|
};
|
|
2005
2005
|
}
|
package/src/services/avatars.ts
CHANGED
|
@@ -22,41 +22,41 @@ export class Avatars {
|
|
|
22
22
|
* 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
23
|
*
|
|
24
24
|
* @param {Browser} params.code - Browser Code.
|
|
25
|
-
* @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
26
|
-
* @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
27
|
-
* @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
25
|
+
* @param {number | bigint} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
26
|
+
* @param {number | bigint} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
27
|
+
* @param {number | bigint} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
28
28
|
* @throws {AppwriteException}
|
|
29
29
|
* @returns {string}
|
|
30
30
|
*/
|
|
31
|
-
getBrowser(params: { code: Browser, width?: number, height?: number, quality?: number }): string;
|
|
31
|
+
getBrowser(params: { code: Browser, width?: number | bigint, height?: number | bigint, quality?: number | bigint }): string;
|
|
32
32
|
/**
|
|
33
33
|
* 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.
|
|
34
34
|
*
|
|
35
35
|
* 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.
|
|
36
36
|
*
|
|
37
37
|
* @param {Browser} code - Browser Code.
|
|
38
|
-
* @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
39
|
-
* @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
40
|
-
* @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
38
|
+
* @param {number | bigint} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
39
|
+
* @param {number | bigint} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
40
|
+
* @param {number | bigint} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
41
41
|
* @throws {AppwriteException}
|
|
42
42
|
* @returns {string}
|
|
43
43
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
44
44
|
*/
|
|
45
|
-
getBrowser(code: Browser, width?: number, height?: number, quality?: number): string;
|
|
45
|
+
getBrowser(code: Browser, width?: number | bigint, height?: number | bigint, quality?: number | bigint): string;
|
|
46
46
|
getBrowser(
|
|
47
|
-
paramsOrFirst: { code: Browser, width?: number, height?: number, quality?: number } | Browser,
|
|
48
|
-
...rest: [(number)?, (number)?, (number)?]
|
|
47
|
+
paramsOrFirst: { code: Browser, width?: number | bigint, height?: number | bigint, quality?: number | bigint } | Browser,
|
|
48
|
+
...rest: [(number | bigint)?, (number | bigint)?, (number | bigint)?]
|
|
49
49
|
): string {
|
|
50
|
-
let params: { code: Browser, width?: number, height?: number, quality?: number };
|
|
50
|
+
let params: { code: Browser, width?: number | bigint, height?: number | bigint, quality?: number | bigint };
|
|
51
51
|
|
|
52
52
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && 'code' in paramsOrFirst)) {
|
|
53
|
-
params = (paramsOrFirst || {}) as { code: Browser, width?: number, height?: number, quality?: number };
|
|
53
|
+
params = (paramsOrFirst || {}) as { code: Browser, width?: number | bigint, height?: number | bigint, quality?: number | bigint };
|
|
54
54
|
} else {
|
|
55
55
|
params = {
|
|
56
56
|
code: paramsOrFirst as Browser,
|
|
57
|
-
width: rest[0] as number,
|
|
58
|
-
height: rest[1] as number,
|
|
59
|
-
quality: rest[2] as number
|
|
57
|
+
width: rest[0] as number | bigint,
|
|
58
|
+
height: rest[1] as number | bigint,
|
|
59
|
+
quality: rest[2] as number | bigint
|
|
60
60
|
};
|
|
61
61
|
}
|
|
62
62
|
|
|
@@ -101,13 +101,13 @@ export class Avatars {
|
|
|
101
101
|
*
|
|
102
102
|
*
|
|
103
103
|
* @param {CreditCard} params.code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.
|
|
104
|
-
* @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
105
|
-
* @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
106
|
-
* @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
104
|
+
* @param {number | bigint} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
105
|
+
* @param {number | bigint} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
106
|
+
* @param {number | bigint} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
107
107
|
* @throws {AppwriteException}
|
|
108
108
|
* @returns {string}
|
|
109
109
|
*/
|
|
110
|
-
getCreditCard(params: { code: CreditCard, width?: number, height?: number, quality?: number }): string;
|
|
110
|
+
getCreditCard(params: { code: CreditCard, width?: number | bigint, height?: number | bigint, quality?: number | bigint }): string;
|
|
111
111
|
/**
|
|
112
112
|
* 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.
|
|
113
113
|
*
|
|
@@ -115,28 +115,28 @@ export class Avatars {
|
|
|
115
115
|
*
|
|
116
116
|
*
|
|
117
117
|
* @param {CreditCard} code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.
|
|
118
|
-
* @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
119
|
-
* @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
120
|
-
* @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
118
|
+
* @param {number | bigint} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
119
|
+
* @param {number | bigint} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
120
|
+
* @param {number | bigint} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
121
121
|
* @throws {AppwriteException}
|
|
122
122
|
* @returns {string}
|
|
123
123
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
124
124
|
*/
|
|
125
|
-
getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): string;
|
|
125
|
+
getCreditCard(code: CreditCard, width?: number | bigint, height?: number | bigint, quality?: number | bigint): string;
|
|
126
126
|
getCreditCard(
|
|
127
|
-
paramsOrFirst: { code: CreditCard, width?: number, height?: number, quality?: number } | CreditCard,
|
|
128
|
-
...rest: [(number)?, (number)?, (number)?]
|
|
127
|
+
paramsOrFirst: { code: CreditCard, width?: number | bigint, height?: number | bigint, quality?: number | bigint } | CreditCard,
|
|
128
|
+
...rest: [(number | bigint)?, (number | bigint)?, (number | bigint)?]
|
|
129
129
|
): string {
|
|
130
|
-
let params: { code: CreditCard, width?: number, height?: number, quality?: number };
|
|
130
|
+
let params: { code: CreditCard, width?: number | bigint, height?: number | bigint, quality?: number | bigint };
|
|
131
131
|
|
|
132
132
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && 'code' in paramsOrFirst)) {
|
|
133
|
-
params = (paramsOrFirst || {}) as { code: CreditCard, width?: number, height?: number, quality?: number };
|
|
133
|
+
params = (paramsOrFirst || {}) as { code: CreditCard, width?: number | bigint, height?: number | bigint, quality?: number | bigint };
|
|
134
134
|
} else {
|
|
135
135
|
params = {
|
|
136
136
|
code: paramsOrFirst as CreditCard,
|
|
137
|
-
width: rest[0] as number,
|
|
138
|
-
height: rest[1] as number,
|
|
139
|
-
quality: rest[2] as number
|
|
137
|
+
width: rest[0] as number | bigint,
|
|
138
|
+
height: rest[1] as number | bigint,
|
|
139
|
+
quality: rest[2] as number | bigint
|
|
140
140
|
};
|
|
141
141
|
}
|
|
142
142
|
|
|
@@ -240,13 +240,13 @@ export class Avatars {
|
|
|
240
240
|
*
|
|
241
241
|
*
|
|
242
242
|
* @param {Flag} params.code - Country Code. ISO Alpha-2 country code format.
|
|
243
|
-
* @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
244
|
-
* @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
245
|
-
* @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
243
|
+
* @param {number | bigint} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
244
|
+
* @param {number | bigint} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
245
|
+
* @param {number | bigint} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
246
246
|
* @throws {AppwriteException}
|
|
247
247
|
* @returns {string}
|
|
248
248
|
*/
|
|
249
|
-
getFlag(params: { code: Flag, width?: number, height?: number, quality?: number }): string;
|
|
249
|
+
getFlag(params: { code: Flag, width?: number | bigint, height?: number | bigint, quality?: number | bigint }): string;
|
|
250
250
|
/**
|
|
251
251
|
* 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.
|
|
252
252
|
*
|
|
@@ -254,28 +254,28 @@ export class Avatars {
|
|
|
254
254
|
*
|
|
255
255
|
*
|
|
256
256
|
* @param {Flag} code - Country Code. ISO Alpha-2 country code format.
|
|
257
|
-
* @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
258
|
-
* @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
259
|
-
* @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
257
|
+
* @param {number | bigint} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
258
|
+
* @param {number | bigint} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
259
|
+
* @param {number | bigint} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
260
260
|
* @throws {AppwriteException}
|
|
261
261
|
* @returns {string}
|
|
262
262
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
263
263
|
*/
|
|
264
|
-
getFlag(code: Flag, width?: number, height?: number, quality?: number): string;
|
|
264
|
+
getFlag(code: Flag, width?: number | bigint, height?: number | bigint, quality?: number | bigint): string;
|
|
265
265
|
getFlag(
|
|
266
|
-
paramsOrFirst: { code: Flag, width?: number, height?: number, quality?: number } | Flag,
|
|
267
|
-
...rest: [(number)?, (number)?, (number)?]
|
|
266
|
+
paramsOrFirst: { code: Flag, width?: number | bigint, height?: number | bigint, quality?: number | bigint } | Flag,
|
|
267
|
+
...rest: [(number | bigint)?, (number | bigint)?, (number | bigint)?]
|
|
268
268
|
): string {
|
|
269
|
-
let params: { code: Flag, width?: number, height?: number, quality?: number };
|
|
269
|
+
let params: { code: Flag, width?: number | bigint, height?: number | bigint, quality?: number | bigint };
|
|
270
270
|
|
|
271
271
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && 'code' in paramsOrFirst)) {
|
|
272
|
-
params = (paramsOrFirst || {}) as { code: Flag, width?: number, height?: number, quality?: number };
|
|
272
|
+
params = (paramsOrFirst || {}) as { code: Flag, width?: number | bigint, height?: number | bigint, quality?: number | bigint };
|
|
273
273
|
} else {
|
|
274
274
|
params = {
|
|
275
275
|
code: paramsOrFirst as Flag,
|
|
276
|
-
width: rest[0] as number,
|
|
277
|
-
height: rest[1] as number,
|
|
278
|
-
quality: rest[2] as number
|
|
276
|
+
width: rest[0] as number | bigint,
|
|
277
|
+
height: rest[1] as number | bigint,
|
|
278
|
+
quality: rest[2] as number | bigint
|
|
279
279
|
};
|
|
280
280
|
}
|
|
281
281
|
|
|
@@ -321,12 +321,12 @@ export class Avatars {
|
|
|
321
321
|
* This endpoint does not follow HTTP redirects.
|
|
322
322
|
*
|
|
323
323
|
* @param {string} params.url - Image URL which you want to crop.
|
|
324
|
-
* @param {number} params.width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
|
|
325
|
-
* @param {number} params.height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
|
|
324
|
+
* @param {number | bigint} params.width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
|
|
325
|
+
* @param {number | bigint} params.height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
|
|
326
326
|
* @throws {AppwriteException}
|
|
327
327
|
* @returns {string}
|
|
328
328
|
*/
|
|
329
|
-
getImage(params: { url: string, width?: number, height?: number }): string;
|
|
329
|
+
getImage(params: { url: string, width?: number | bigint, height?: number | bigint }): string;
|
|
330
330
|
/**
|
|
331
331
|
* 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.
|
|
332
332
|
*
|
|
@@ -335,26 +335,26 @@ export class Avatars {
|
|
|
335
335
|
* This endpoint does not follow HTTP redirects.
|
|
336
336
|
*
|
|
337
337
|
* @param {string} url - Image URL which you want to crop.
|
|
338
|
-
* @param {number} width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
|
|
339
|
-
* @param {number} height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
|
|
338
|
+
* @param {number | bigint} width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
|
|
339
|
+
* @param {number | bigint} height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
|
|
340
340
|
* @throws {AppwriteException}
|
|
341
341
|
* @returns {string}
|
|
342
342
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
343
343
|
*/
|
|
344
|
-
getImage(url: string, width?: number, height?: number): string;
|
|
344
|
+
getImage(url: string, width?: number | bigint, height?: number | bigint): string;
|
|
345
345
|
getImage(
|
|
346
|
-
paramsOrFirst: { url: string, width?: number, height?: number } | string,
|
|
347
|
-
...rest: [(number)?, (number)?]
|
|
346
|
+
paramsOrFirst: { url: string, width?: number | bigint, height?: number | bigint } | string,
|
|
347
|
+
...rest: [(number | bigint)?, (number | bigint)?]
|
|
348
348
|
): string {
|
|
349
|
-
let params: { url: string, width?: number, height?: number };
|
|
349
|
+
let params: { url: string, width?: number | bigint, height?: number | bigint };
|
|
350
350
|
|
|
351
351
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
352
|
-
params = (paramsOrFirst || {}) as { url: string, width?: number, height?: number };
|
|
352
|
+
params = (paramsOrFirst || {}) as { url: string, width?: number | bigint, height?: number | bigint };
|
|
353
353
|
} else {
|
|
354
354
|
params = {
|
|
355
355
|
url: paramsOrFirst as string,
|
|
356
|
-
width: rest[0] as number,
|
|
357
|
-
height: rest[1] as number
|
|
356
|
+
width: rest[0] as number | bigint,
|
|
357
|
+
height: rest[1] as number | bigint
|
|
358
358
|
};
|
|
359
359
|
}
|
|
360
360
|
|
|
@@ -400,13 +400,13 @@ export class Avatars {
|
|
|
400
400
|
*
|
|
401
401
|
*
|
|
402
402
|
* @param {string} params.name - Full Name. When empty, current user name or email will be used. Max length: 128 chars.
|
|
403
|
-
* @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
404
|
-
* @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
403
|
+
* @param {number | bigint} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
404
|
+
* @param {number | bigint} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
405
405
|
* @param {string} params.background - Changes background color. By default a random color will be picked and stay will persistent to the given name.
|
|
406
406
|
* @throws {AppwriteException}
|
|
407
407
|
* @returns {string}
|
|
408
408
|
*/
|
|
409
|
-
getInitials(params?: { name?: string, width?: number, height?: number, background?: string }): string;
|
|
409
|
+
getInitials(params?: { name?: string, width?: number | bigint, height?: number | bigint, background?: string }): string;
|
|
410
410
|
/**
|
|
411
411
|
* 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.
|
|
412
412
|
*
|
|
@@ -416,27 +416,27 @@ export class Avatars {
|
|
|
416
416
|
*
|
|
417
417
|
*
|
|
418
418
|
* @param {string} name - Full Name. When empty, current user name or email will be used. Max length: 128 chars.
|
|
419
|
-
* @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
420
|
-
* @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
419
|
+
* @param {number | bigint} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
|
|
420
|
+
* @param {number | bigint} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
|
|
421
421
|
* @param {string} background - Changes background color. By default a random color will be picked and stay will persistent to the given name.
|
|
422
422
|
* @throws {AppwriteException}
|
|
423
423
|
* @returns {string}
|
|
424
424
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
425
425
|
*/
|
|
426
|
-
getInitials(name?: string, width?: number, height?: number, background?: string): string;
|
|
426
|
+
getInitials(name?: string, width?: number | bigint, height?: number | bigint, background?: string): string;
|
|
427
427
|
getInitials(
|
|
428
|
-
paramsOrFirst?: { name?: string, width?: number, height?: number, background?: string } | string,
|
|
429
|
-
...rest: [(number)?, (number)?, (string)?]
|
|
428
|
+
paramsOrFirst?: { name?: string, width?: number | bigint, height?: number | bigint, background?: string } | string,
|
|
429
|
+
...rest: [(number | bigint)?, (number | bigint)?, (string)?]
|
|
430
430
|
): string {
|
|
431
|
-
let params: { name?: string, width?: number, height?: number, background?: string };
|
|
431
|
+
let params: { name?: string, width?: number | bigint, height?: number | bigint, background?: string };
|
|
432
432
|
|
|
433
433
|
if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
434
|
-
params = (paramsOrFirst || {}) as { name?: string, width?: number, height?: number, background?: string };
|
|
434
|
+
params = (paramsOrFirst || {}) as { name?: string, width?: number | bigint, height?: number | bigint, background?: string };
|
|
435
435
|
} else {
|
|
436
436
|
params = {
|
|
437
437
|
name: paramsOrFirst as string,
|
|
438
|
-
width: rest[0] as number,
|
|
439
|
-
height: rest[1] as number,
|
|
438
|
+
width: rest[0] as number | bigint,
|
|
439
|
+
height: rest[1] as number | bigint,
|
|
440
440
|
background: rest[2] as string
|
|
441
441
|
};
|
|
442
442
|
}
|
|
@@ -480,39 +480,39 @@ export class Avatars {
|
|
|
480
480
|
*
|
|
481
481
|
*
|
|
482
482
|
* @param {string} params.text - Plain text to be converted to QR code image.
|
|
483
|
-
* @param {number} params.size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
|
|
484
|
-
* @param {number} params.margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
|
|
483
|
+
* @param {number | bigint} params.size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
|
|
484
|
+
* @param {number | bigint} params.margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
|
|
485
485
|
* @param {boolean} params.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.
|
|
486
486
|
* @throws {AppwriteException}
|
|
487
487
|
* @returns {string}
|
|
488
488
|
*/
|
|
489
|
-
getQR(params: { text: string, size?: number, margin?: number, download?: boolean }): string;
|
|
489
|
+
getQR(params: { text: string, size?: number | bigint, margin?: number | bigint, download?: boolean }): string;
|
|
490
490
|
/**
|
|
491
491
|
* 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.
|
|
492
492
|
*
|
|
493
493
|
*
|
|
494
494
|
* @param {string} text - Plain text to be converted to QR code image.
|
|
495
|
-
* @param {number} size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
|
|
496
|
-
* @param {number} margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
|
|
495
|
+
* @param {number | bigint} size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
|
|
496
|
+
* @param {number | bigint} margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
|
|
497
497
|
* @param {boolean} 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.
|
|
498
498
|
* @throws {AppwriteException}
|
|
499
499
|
* @returns {string}
|
|
500
500
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
501
501
|
*/
|
|
502
|
-
getQR(text: string, size?: number, margin?: number, download?: boolean): string;
|
|
502
|
+
getQR(text: string, size?: number | bigint, margin?: number | bigint, download?: boolean): string;
|
|
503
503
|
getQR(
|
|
504
|
-
paramsOrFirst: { text: string, size?: number, margin?: number, download?: boolean } | string,
|
|
505
|
-
...rest: [(number)?, (number)?, (boolean)?]
|
|
504
|
+
paramsOrFirst: { text: string, size?: number | bigint, margin?: number | bigint, download?: boolean } | string,
|
|
505
|
+
...rest: [(number | bigint)?, (number | bigint)?, (boolean)?]
|
|
506
506
|
): string {
|
|
507
|
-
let params: { text: string, size?: number, margin?: number, download?: boolean };
|
|
507
|
+
let params: { text: string, size?: number | bigint, margin?: number | bigint, download?: boolean };
|
|
508
508
|
|
|
509
509
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
510
|
-
params = (paramsOrFirst || {}) as { text: string, size?: number, margin?: number, download?: boolean };
|
|
510
|
+
params = (paramsOrFirst || {}) as { text: string, size?: number | bigint, margin?: number | bigint, download?: boolean };
|
|
511
511
|
} else {
|
|
512
512
|
params = {
|
|
513
513
|
text: paramsOrFirst as string,
|
|
514
|
-
size: rest[0] as number,
|
|
515
|
-
margin: rest[1] as number,
|
|
514
|
+
size: rest[0] as number | bigint,
|
|
515
|
+
margin: rest[1] as number | bigint,
|
|
516
516
|
download: rest[2] as boolean
|
|
517
517
|
};
|
|
518
518
|
}
|
|
@@ -563,28 +563,28 @@ export class Avatars {
|
|
|
563
563
|
*
|
|
564
564
|
* @param {string} params.url - Website URL which you want to capture.
|
|
565
565
|
* @param {object} params.headers - HTTP headers to send with the browser request. Defaults to empty.
|
|
566
|
-
* @param {number} params.viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
|
|
567
|
-
* @param {number} params.viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
|
|
568
|
-
* @param {number} params.scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
|
|
566
|
+
* @param {number | bigint} params.viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
|
|
567
|
+
* @param {number | bigint} params.viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
|
|
568
|
+
* @param {number | bigint} params.scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
|
|
569
569
|
* @param {Theme} params.theme - Browser theme. Pass "light" or "dark". Defaults to "light".
|
|
570
570
|
* @param {string} params.userAgent - Custom user agent string. Defaults to browser default.
|
|
571
571
|
* @param {boolean} params.fullpage - Capture full page scroll. Pass 0 for viewport only, or 1 for full page. Defaults to 0.
|
|
572
572
|
* @param {string} params.locale - Browser locale (e.g., "en-US", "fr-FR"). Defaults to browser default.
|
|
573
573
|
* @param {Timezone} params.timezone - IANA timezone identifier (e.g., "America/New_York", "Europe/London"). Defaults to browser default.
|
|
574
|
-
* @param {number} params.latitude - Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.
|
|
575
|
-
* @param {number} params.longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
|
|
576
|
-
* @param {number} params.accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
|
|
574
|
+
* @param {number | bigint} params.latitude - Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.
|
|
575
|
+
* @param {number | bigint} params.longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
|
|
576
|
+
* @param {number | bigint} params.accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
|
|
577
577
|
* @param {boolean} params.touch - Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.
|
|
578
578
|
* @param {string[]} params.permissions - Browser permissions to grant. Pass an array of permission names like ["geolocation", "camera", "microphone"]. Defaults to empty.
|
|
579
|
-
* @param {number} params.sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
|
|
580
|
-
* @param {number} params.width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
|
|
581
|
-
* @param {number} params.height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
|
|
582
|
-
* @param {number} params.quality - Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
579
|
+
* @param {number | bigint} params.sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
|
|
580
|
+
* @param {number | bigint} params.width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
|
|
581
|
+
* @param {number | bigint} params.height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
|
|
582
|
+
* @param {number | bigint} params.quality - Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
583
583
|
* @param {ImageFormat} params.output - Output format type (jpeg, jpg, png, gif and webp).
|
|
584
584
|
* @throws {AppwriteException}
|
|
585
585
|
* @returns {string}
|
|
586
586
|
*/
|
|
587
|
-
getScreenshot(params: { url: string, headers?: object, viewportWidth?: number, viewportHeight?: number, scale?: number, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number, longitude?: number, accuracy?: number, touch?: boolean, permissions?: string[], sleep?: number, width?: number, height?: number, quality?: number, output?: ImageFormat }): string;
|
|
587
|
+
getScreenshot(params: { url: string, headers?: object, viewportWidth?: number | bigint, viewportHeight?: number | bigint, scale?: number | bigint, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number | bigint, longitude?: number | bigint, accuracy?: number | bigint, touch?: boolean, permissions?: string[], sleep?: number | bigint, width?: number | bigint, height?: number | bigint, quality?: number | bigint, output?: ImageFormat }): string;
|
|
588
588
|
/**
|
|
589
589
|
* Use this endpoint to capture a screenshot of any website URL. This endpoint uses a headless browser to render the webpage and capture it as an image.
|
|
590
590
|
*
|
|
@@ -594,58 +594,58 @@ export class Avatars {
|
|
|
594
594
|
*
|
|
595
595
|
* @param {string} url - Website URL which you want to capture.
|
|
596
596
|
* @param {object} headers - HTTP headers to send with the browser request. Defaults to empty.
|
|
597
|
-
* @param {number} viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
|
|
598
|
-
* @param {number} viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
|
|
599
|
-
* @param {number} scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
|
|
597
|
+
* @param {number | bigint} viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
|
|
598
|
+
* @param {number | bigint} viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
|
|
599
|
+
* @param {number | bigint} scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
|
|
600
600
|
* @param {Theme} theme - Browser theme. Pass "light" or "dark". Defaults to "light".
|
|
601
601
|
* @param {string} userAgent - Custom user agent string. Defaults to browser default.
|
|
602
602
|
* @param {boolean} fullpage - Capture full page scroll. Pass 0 for viewport only, or 1 for full page. Defaults to 0.
|
|
603
603
|
* @param {string} locale - Browser locale (e.g., "en-US", "fr-FR"). Defaults to browser default.
|
|
604
604
|
* @param {Timezone} timezone - IANA timezone identifier (e.g., "America/New_York", "Europe/London"). Defaults to browser default.
|
|
605
|
-
* @param {number} latitude - Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.
|
|
606
|
-
* @param {number} longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
|
|
607
|
-
* @param {number} accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
|
|
605
|
+
* @param {number | bigint} latitude - Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.
|
|
606
|
+
* @param {number | bigint} longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
|
|
607
|
+
* @param {number | bigint} accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
|
|
608
608
|
* @param {boolean} touch - Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.
|
|
609
609
|
* @param {string[]} permissions - Browser permissions to grant. Pass an array of permission names like ["geolocation", "camera", "microphone"]. Defaults to empty.
|
|
610
|
-
* @param {number} sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
|
|
611
|
-
* @param {number} width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
|
|
612
|
-
* @param {number} height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
|
|
613
|
-
* @param {number} quality - Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
610
|
+
* @param {number | bigint} sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
|
|
611
|
+
* @param {number | bigint} width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
|
|
612
|
+
* @param {number | bigint} height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
|
|
613
|
+
* @param {number | bigint} quality - Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
614
614
|
* @param {ImageFormat} output - Output format type (jpeg, jpg, png, gif and webp).
|
|
615
615
|
* @throws {AppwriteException}
|
|
616
616
|
* @returns {string}
|
|
617
617
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
618
618
|
*/
|
|
619
|
-
getScreenshot(url: string, headers?: object, viewportWidth?: number, viewportHeight?: number, scale?: number, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number, longitude?: number, accuracy?: number, touch?: boolean, permissions?: string[], sleep?: number, width?: number, height?: number, quality?: number, output?: ImageFormat): string;
|
|
619
|
+
getScreenshot(url: string, headers?: object, viewportWidth?: number | bigint, viewportHeight?: number | bigint, scale?: number | bigint, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number | bigint, longitude?: number | bigint, accuracy?: number | bigint, touch?: boolean, permissions?: string[], sleep?: number | bigint, width?: number | bigint, height?: number | bigint, quality?: number | bigint, output?: ImageFormat): string;
|
|
620
620
|
getScreenshot(
|
|
621
|
-
paramsOrFirst: { url: string, headers?: object, viewportWidth?: number, viewportHeight?: number, scale?: number, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number, longitude?: number, accuracy?: number, touch?: boolean, permissions?: string[], sleep?: number, width?: number, height?: number, quality?: number, output?: ImageFormat } | string,
|
|
622
|
-
...rest: [(object)?, (number)?, (number)?, (number)?, (Theme)?, (string)?, (boolean)?, (string)?, (Timezone)?, (number)?, (number)?, (number)?, (boolean)?, (string[])?, (number)?, (number)?, (number)?, (number)?, (ImageFormat)?]
|
|
621
|
+
paramsOrFirst: { url: string, headers?: object, viewportWidth?: number | bigint, viewportHeight?: number | bigint, scale?: number | bigint, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number | bigint, longitude?: number | bigint, accuracy?: number | bigint, touch?: boolean, permissions?: string[], sleep?: number | bigint, width?: number | bigint, height?: number | bigint, quality?: number | bigint, output?: ImageFormat } | string,
|
|
622
|
+
...rest: [(object)?, (number | bigint)?, (number | bigint)?, (number | bigint)?, (Theme)?, (string)?, (boolean)?, (string)?, (Timezone)?, (number | bigint)?, (number | bigint)?, (number | bigint)?, (boolean)?, (string[])?, (number | bigint)?, (number | bigint)?, (number | bigint)?, (number | bigint)?, (ImageFormat)?]
|
|
623
623
|
): string {
|
|
624
|
-
let params: { url: string, headers?: object, viewportWidth?: number, viewportHeight?: number, scale?: number, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number, longitude?: number, accuracy?: number, touch?: boolean, permissions?: string[], sleep?: number, width?: number, height?: number, quality?: number, output?: ImageFormat };
|
|
624
|
+
let params: { url: string, headers?: object, viewportWidth?: number | bigint, viewportHeight?: number | bigint, scale?: number | bigint, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number | bigint, longitude?: number | bigint, accuracy?: number | bigint, touch?: boolean, permissions?: string[], sleep?: number | bigint, width?: number | bigint, height?: number | bigint, quality?: number | bigint, output?: ImageFormat };
|
|
625
625
|
|
|
626
626
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
627
|
-
params = (paramsOrFirst || {}) as { url: string, headers?: object, viewportWidth?: number, viewportHeight?: number, scale?: number, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number, longitude?: number, accuracy?: number, touch?: boolean, permissions?: string[], sleep?: number, width?: number, height?: number, quality?: number, output?: ImageFormat };
|
|
627
|
+
params = (paramsOrFirst || {}) as { url: string, headers?: object, viewportWidth?: number | bigint, viewportHeight?: number | bigint, scale?: number | bigint, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number | bigint, longitude?: number | bigint, accuracy?: number | bigint, touch?: boolean, permissions?: string[], sleep?: number | bigint, width?: number | bigint, height?: number | bigint, quality?: number | bigint, output?: ImageFormat };
|
|
628
628
|
} else {
|
|
629
629
|
params = {
|
|
630
630
|
url: paramsOrFirst as string,
|
|
631
631
|
headers: rest[0] as object,
|
|
632
|
-
viewportWidth: rest[1] as number,
|
|
633
|
-
viewportHeight: rest[2] as number,
|
|
634
|
-
scale: rest[3] as number,
|
|
632
|
+
viewportWidth: rest[1] as number | bigint,
|
|
633
|
+
viewportHeight: rest[2] as number | bigint,
|
|
634
|
+
scale: rest[3] as number | bigint,
|
|
635
635
|
theme: rest[4] as Theme,
|
|
636
636
|
userAgent: rest[5] as string,
|
|
637
637
|
fullpage: rest[6] as boolean,
|
|
638
638
|
locale: rest[7] as string,
|
|
639
639
|
timezone: rest[8] as Timezone,
|
|
640
|
-
latitude: rest[9] as number,
|
|
641
|
-
longitude: rest[10] as number,
|
|
642
|
-
accuracy: rest[11] as number,
|
|
640
|
+
latitude: rest[9] as number | bigint,
|
|
641
|
+
longitude: rest[10] as number | bigint,
|
|
642
|
+
accuracy: rest[11] as number | bigint,
|
|
643
643
|
touch: rest[12] as boolean,
|
|
644
644
|
permissions: rest[13] as string[],
|
|
645
|
-
sleep: rest[14] as number,
|
|
646
|
-
width: rest[15] as number,
|
|
647
|
-
height: rest[16] as number,
|
|
648
|
-
quality: rest[17] as number,
|
|
645
|
+
sleep: rest[14] as number | bigint,
|
|
646
|
+
width: rest[15] as number | bigint,
|
|
647
|
+
height: rest[16] as number | bigint,
|
|
648
|
+
quality: rest[17] as number | bigint,
|
|
649
649
|
output: rest[18] as ImageFormat
|
|
650
650
|
};
|
|
651
651
|
}
|