Class: Appwrite::Avatars

Inherits:
Service show all
Defined in:
lib/appwrite/services/avatars.rb

Instance Method Summary collapse

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from Appwrite::Service

Instance Method Details

#get_browser(code:, width: nil, height: nil, quality: nil) ⇒ Object

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 /account/sessions endpoint. Use width, height and quality arguments to change the output settings.

Parameters:

  • code (string) —

    Browser Code.

  • width (number) (defaults to: nil) —

    Image width. Pass an integer between 0 to 2000. Defaults to 100.

  • height (number) (defaults to: nil) —

    Image height. Pass an integer between 0 to 2000. Defaults to 100.

  • quality (number) (defaults to: nil) —

    Image quality. Pass an integer between 0 to 100. Defaults to 100.

Returns:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/appwrite/services/avatars.rb', line 17

def get_browser(code:, width: nil, height: nil, quality: nil)
    if code.nil?
        raise Appwrite::Exception.new('Missing required parameter: "code"')
    end

    path = '/avatars/browsers/{code}'
        .gsub('{code}', code)

    params = {
        width: width,
        height: height,
        quality: quality,
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
    )
end

#get_credit_card(code:, width: nil, height: nil, quality: nil) ⇒ Object

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.

Parameters:

  • code (string) —

    Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.

  • width (number) (defaults to: nil) —

    Image width. Pass an integer between 0 to 2000. Defaults to 100.

  • height (number) (defaults to: nil) —

    Image height. Pass an integer between 0 to 2000. Defaults to 100.

  • quality (number) (defaults to: nil) —

    Image quality. Pass an integer between 0 to 100. Defaults to 100.

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/appwrite/services/avatars.rb', line 53

def get_credit_card(code:, width: nil, height: nil, quality: nil)
    if code.nil?
        raise Appwrite::Exception.new('Missing required parameter: "code"')
    end

    path = '/avatars/credit-cards/{code}'
        .gsub('{code}', code)

    params = {
        width: width,
        height: height,
        quality: quality,
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
    )
end

#get_favicon(url:) ⇒ Object

Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.

Parameters:

  • url (string) —

    Website URL which you want to fetch the favicon from.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/appwrite/services/avatars.rb', line 86

def get_favicon(url:)
    if url.nil?
        raise Appwrite::Exception.new('Missing required parameter: "url"')
    end

    path = '/avatars/favicon'

    params = {
        url: url,
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
    )
end

#get_flag(code:, width: nil, height: nil, quality: nil) ⇒ Object

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.

Parameters:

  • code (string) —

    Country Code. ISO Alpha-2 country code format.

  • width (number) (defaults to: nil) —

    Image width. Pass an integer between 0 to 2000. Defaults to 100.

  • height (number) (defaults to: nil) —

    Image height. Pass an integer between 0 to 2000. Defaults to 100.

  • quality (number) (defaults to: nil) —

    Image quality. Pass an integer between 0 to 100. Defaults to 100.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/appwrite/services/avatars.rb', line 119

def get_flag(code:, width: nil, height: nil, quality: nil)
    if code.nil?
        raise Appwrite::Exception.new('Missing required parameter: "code"')
    end

    path = '/avatars/flags/{code}'
        .gsub('{code}', code)

    params = {
        width: width,
        height: height,
        quality: quality,
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
    )
end

#get_image(url:, width: nil, height: nil) ⇒ Object

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.

Parameters:

  • url (string) —

    Image URL which you want to crop.

  • width (number) (defaults to: nil) —

    Resize preview image width, Pass an integer between 0 to 2000.

  • height (number) (defaults to: nil) —

    Resize preview image height, Pass an integer between 0 to 2000.

Returns:



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/appwrite/services/avatars.rb', line 155

def get_image(url:, width: nil, height: nil)
    if url.nil?
        raise Appwrite::Exception.new('Missing required parameter: "url"')
    end

    path = '/avatars/image'

    params = {
        url: url,
        width: width,
        height: height,
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
    )
end

#get_initials(name: nil, width: nil, height: nil, color: nil, background: nil) ⇒ Object

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.

Parameters:

  • name (string) (defaults to: nil) —

    Full Name. When empty, current user name or email will be used. Max length: 128 chars.

  • width (number) (defaults to: nil) —

    Image width. Pass an integer between 0 to 2000. Defaults to 100.

  • height (number) (defaults to: nil) —

    Image height. Pass an integer between 0 to 2000. Defaults to 100.

  • color (string) (defaults to: nil) —

    Changes text color. By default a random color will be picked and stay will persistent to the given name.

  • background (string) (defaults to: nil) —

    Changes background color. By default a random color will be picked and stay will persistent to the given name.

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/appwrite/services/avatars.rb', line 198

def get_initials(name: nil, width: nil, height: nil, color: nil, background: nil)
    path = '/avatars/initials'

    params = {
        name: name,
        width: width,
        height: height,
        color: color,
        background: background,
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
    )
end

#get_qr(text:, size: nil, margin: nil, download: nil) ⇒ Object

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.

Parameters:

  • text (string) —

    Plain text to be converted to QR code image.

  • size (number) (defaults to: nil) —

    QR code size. Pass an integer between 0 to 1000. Defaults to 400.

  • margin (number) (defaults to: nil) —

    Margin from edge. Pass an integer between 0 to 10. Defaults to 1.

  • download (boolean) (defaults to: nil) —

    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.

Returns:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/appwrite/services/avatars.rb', line 230

def get_qr(text:, size: nil, margin: nil, download: nil)
    if text.nil?
        raise Appwrite::Exception.new('Missing required parameter: "text"')
    end

    path = '/avatars/qr'

    params = {
        text: text,
        size: size,
        margin: margin,
        download: download,
    }

    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
    )
end