1
0
Fork 0
mirror of synced 2024-08-21 05:02:07 +12:00
appwrite/app/sdks/php/docs/avatars.md

101 lines
3.3 KiB
Markdown
Raw Normal View History

2019-05-09 18:54:39 +12:00
# Avatars Service
## Get Browser Icon
```http request
2019-10-09 17:16:38 +13:00
GET https://appwrite.io/v1/avatars/browsers/{code}
2019-05-09 18:54:39 +12:00
```
2019-10-09 17:16:38 +13:00
** /docs/references/avatars/get-browser.md **
2019-05-09 18:54:39 +12:00
### Parameters
| Field Name | Type | Description | Default |
| --- | --- | --- | --- |
| code | string | **Required** Browser Code. | |
| width | integer | Image width. Pass an integer between 0 to 2000. Defaults to 100 | 100 |
| height | integer | Image height. Pass an integer between 0 to 2000. Defaults to 100 | 100 |
| quality | integer | Image quality. Pass an integer between 0 to 100. Defaults to 100 | 100 |
## Get Credit Card Icon
```http request
2019-10-09 17:16:38 +13:00
GET https://appwrite.io/v1/avatars/credit-cards/{code}
2019-05-09 18:54:39 +12:00
```
2019-10-09 17:16:38 +13:00
** /docs/references/avatars/get-credit-cards.md **
2019-05-09 18:54:39 +12:00
### Parameters
| Field Name | Type | Description | Default |
| --- | --- | --- | --- |
| code | string | **Required** Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa. | |
| width | integer | Image width. Pass an integer between 0 to 2000. Defaults to 100 | 100 |
| height | integer | Image height. Pass an integer between 0 to 2000. Defaults to 100 | 100 |
| quality | integer | Image quality. Pass an integer between 0 to 100. Defaults to 100 | 100 |
## Get Favicon
```http request
2019-10-09 17:16:38 +13:00
GET https://appwrite.io/v1/avatars/favicon
2019-05-09 18:54:39 +12:00
```
2019-10-09 17:16:38 +13:00
** /docs/references/avatars/get-favicon.md **
2019-05-09 18:54:39 +12:00
### Parameters
| Field Name | Type | Description | Default |
| --- | --- | --- | --- |
| url | string | **Required** Website URL which you want to fetch the favicon from. | |
## Get Country Flag
```http request
2019-10-09 17:16:38 +13:00
GET https://appwrite.io/v1/avatars/flags/{code}
2019-05-09 18:54:39 +12:00
```
2019-10-09 17:16:38 +13:00
** /docs/references/avatars/get-flag.md **
2019-05-09 18:54:39 +12:00
### Parameters
| Field Name | Type | Description | Default |
| --- | --- | --- | --- |
| code | string | **Required** Country Code. ISO Alpha-2 country code format. | |
| width | integer | Image width. Pass an integer between 0 to 2000. Defaults to 100 | 100 |
| height | integer | Image height. Pass an integer between 0 to 2000. Defaults to 100 | 100 |
| quality | integer | Image quality. Pass an integer between 0 to 100. Defaults to 100 | 100 |
2019-08-27 21:12:40 +12:00
## Get Image from URL
2019-07-21 23:54:45 +12:00
```http request
2019-10-09 17:16:38 +13:00
GET https://appwrite.io/v1/avatars/image
2019-07-21 23:54:45 +12:00
```
2019-10-09 17:16:38 +13:00
** /docs/references/avatars/get-image.md **
2019-07-21 23:54:45 +12:00
### Parameters
| Field Name | Type | Description | Default |
| --- | --- | --- | --- |
| url | string | **Required** Image URL which you want to crop. | |
| width | integer | Resize preview image width, Pass an integer between 0 to 4000 | 400 |
| height | integer | Resize preview image height, Pass an integer between 0 to 4000 | 400 |
2019-05-09 18:54:39 +12:00
## Text to QR Generator
```http request
2019-10-09 17:16:38 +13:00
GET https://appwrite.io/v1/avatars/qr
2019-05-09 18:54:39 +12:00
```
2019-10-09 17:16:38 +13:00
** /docs/references/avatars/get-qr.md **
2019-05-09 18:54:39 +12:00
### Parameters
| Field Name | Type | Description | Default |
| --- | --- | --- | --- |
| text | string | **Required** Plain text to be converted to QR code image | |
| size | integer | QR code size. Pass an integer between 0 to 1000. Defaults to 400. | 400 |
| margin | integer | Margin From Edge. Pass an integer between 0 to 10. Defaults to 1. | 1 |
2019-08-23 09:10:32 +12:00
| download | integer | 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. | 0 |
2019-05-09 18:54:39 +12:00