Class: Appwrite::Storage

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Storage

Returns a new instance of Storage.



6
7
8
 
# File 'lib/appwrite/services/storage.rb', line 6

def initialize(client)
    @client = client
end

Instance Method Details

#create_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil, transformations: nil) ⇒ Bucket

Create a new storage bucket.

Parameters:

  • bucket_id (String) —

    Unique 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.

  • name (String) —

    Bucket name

  • permissions (Array) (defaults to: nil) —

    An array of permission strings. By default, no user is granted with any permissions. Learn more about permissions.

  • [] —

    file_security Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. Learn more about permissions.

  • [] —

    enabled Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.

  • maximum_file_size (Integer) (defaults to: nil) —

    Maximum file size allowed in bytes. Maximum allowed value is 5GB.

  • allowed_file_extensions (Array) (defaults to: nil) —

    Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.

  • compression (Compression) (defaults to: nil) —

    Compression algorithm chosen for compression. Can be one of none, gzip, or zstd, For file size above 20MB compression is skipped even if it's enabled

  • [] —

    encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled

  • [] —

    antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled

  • [] —

    transformations Are image transformations enabled?

Returns:

  • (Bucket) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/appwrite/services/storage.rb', line 57

def create_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil, transformations: nil)
    api_path = '/storage/buckets'

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

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

    api_params = {
        bucketId: bucket_id,
        name: name,
        permissions: permissions,
        fileSecurity: file_security,
        enabled: enabled,
        maximumFileSize: maximum_file_size,
        allowedFileExtensions: allowed_file_extensions,
        compression: compression,
        encryption: encryption,
        antivirus: antivirus,
        transformations: transformations,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
        "accept": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Bucket
    )

end

#create_file(bucket_id:, file_id:, file:, permissions: nil, on_progress: nil) ⇒ File

Create a new file. Before using this route, you should create a new bucket resource using either a server integration API or directly from your Appwrite console.

Larger files should be uploaded using multiple requests with the content-range header to send a partial request with a maximum supported chunk of 5MB. The content-range header values should always be in bytes.

When the first request is sent, the server will return the File object, and the subsequent part request must include the file's id in x-appwrite-id header to allow the server to know that the partial upload is for the existing file and not for a new one.

If you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.

Parameters:

  • bucket_id (String) —

    Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.

  • file_id (String) —

    File 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.

  • file (file) —

    Binary file. Appwrite SDKs provide helpers to handle file input. Learn about file input.

  • permissions (Array) (defaults to: nil) —

    An array of permission strings. By default, only the current user is granted all permissions. Learn more about permissions.

Returns:

  • (File) 


279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/appwrite/services/storage.rb', line 279

def create_file(bucket_id:, file_id:, file:, permissions: nil, on_progress: nil)
    api_path = '/storage/buckets/{bucketId}/files'
        .gsub('{bucketId}', bucket_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    if file_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "fileId"')
    end

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

    api_params = {
        fileId: file_id,
        file: file,
        permissions: permissions,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'multipart/form-data',
        "accept": 'application/json',
    }

    id_param_name = "fileId"
    param_name = 'file'

    @client.chunked_upload(
        path: api_path,
        headers: api_headers,
        params: api_params,
        param_name: param_name,
        id_param_name: id_param_name,
        on_progress: on_progress,
        response_type: Models::File
    )

end

#delete_bucket(bucket_id:) ⇒ Object

Delete a storage bucket by its unique ID.

Parameters:

  • bucket_id (String) —

    Bucket unique ID.

Returns:

  • []



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/appwrite/services/storage.rb', line 191

def delete_bucket(bucket_id:)
    api_path = '/storage/buckets/{bucketId}'
        .gsub('{bucketId}', bucket_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#delete_file(bucket_id:, file_id:) ⇒ Object

Delete a file by its unique ID. Only users with write permissions have access to delete this resource.

Parameters:

  • bucket_id (String) —

    Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.

  • file_id (String) —

    File ID.

Returns:

  • []



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/appwrite/services/storage.rb', line 410

def delete_file(bucket_id:, file_id:)
    api_path = '/storage/buckets/{bucketId}/files/{fileId}'
        .gsub('{bucketId}', bucket_id)
        .gsub('{fileId}', file_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    if file_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "fileId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#get_bucket(bucket_id:) ⇒ Bucket

Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.

Parameters:

  • bucket_id (String) —

    Bucket unique ID.

Returns:

  • (Bucket) 


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/appwrite/services/storage.rb', line 104

def get_bucket(bucket_id:)
    api_path = '/storage/buckets/{bucketId}'
        .gsub('{bucketId}', bucket_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "accept": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Bucket
    )

end

#get_file(bucket_id:, file_id:) ⇒ File

Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.

Parameters:

  • bucket_id (String) —

    Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.

  • file_id (String) —

    File ID.

Returns:

  • (File) 


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/appwrite/services/storage.rb', line 329

def get_file(bucket_id:, file_id:)
    api_path = '/storage/buckets/{bucketId}/files/{fileId}'
        .gsub('{bucketId}', bucket_id)
        .gsub('{fileId}', file_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    if file_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "fileId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "accept": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::File
    )

end

#get_file_download(bucket_id:, file_id:, token: nil) ⇒ Object

Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.

Parameters:

  • bucket_id (String) —

    Storage bucket ID. You can create a new storage bucket using the Storage service server integration.

  • file_id (String) —

    File ID.

  • token (String) (defaults to: nil) —

    File token for accessing this file.

Returns:

  • []



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/appwrite/services/storage.rb', line 449

def get_file_download(bucket_id:, file_id:, token: nil)
    api_path = '/storage/buckets/{bucketId}/files/{fileId}/download'
        .gsub('{bucketId}', bucket_id)
        .gsub('{fileId}', file_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    if file_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "fileId"')
    end

    api_params = {
        token: token,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "accept": '*/*',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#get_file_preview(bucket_id:, file_id:, width: nil, height: nil, gravity: nil, quality: nil, border_width: nil, border_color: nil, border_radius: nil, opacity: nil, rotation: nil, background: nil, output: nil, token: nil) ⇒ Object

Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.

Parameters:

  • bucket_id (String) —

    Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.

  • file_id (String) —

    File ID

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

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

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

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

  • gravity (ImageGravity) (defaults to: nil) —

    Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right

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

    Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.

  • border_width (Integer) (defaults to: nil) —

    Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.

  • border_color (String) (defaults to: nil) —

    Preview image border color. Use a valid HEX color, no # is needed for prefix.

  • border_radius (Integer) (defaults to: nil) —

    Preview image border radius in pixels. Pass an integer between 0 to 4000.

  • opacity (Float) (defaults to: nil) —

    Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.

  • rotation (Integer) (defaults to: nil) —

    Preview image rotation in degrees. Pass an integer between -360 and 360.

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

    Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.

  • output (ImageFormat) (defaults to: nil) —

    Output format type (jpeg, jpg, png, gif and webp).

  • token (String) (defaults to: nil) —

    File token for accessing this file.

Returns:

  • []



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/appwrite/services/storage.rb', line 502

def get_file_preview(bucket_id:, file_id:, width: nil, height: nil, gravity: nil, quality: nil, border_width: nil, border_color: nil, border_radius: nil, opacity: nil, rotation: nil, background: nil, output: nil, token: nil)
    api_path = '/storage/buckets/{bucketId}/files/{fileId}/preview'
        .gsub('{bucketId}', bucket_id)
        .gsub('{fileId}', file_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    if file_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "fileId"')
    end

    api_params = {
        width: width,
        height: height,
        gravity: gravity,
        quality: quality,
        borderWidth: border_width,
        borderColor: border_color,
        borderRadius: border_radius,
        opacity: opacity,
        rotation: rotation,
        background: background,
        output: output,
        token: token,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "accept": 'image/*',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#get_file_view(bucket_id:, file_id:, token: nil) ⇒ Object

Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.

Parameters:

  • bucket_id (String) —

    Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.

  • file_id (String) —

    File ID.

  • token (String) (defaults to: nil) —

    File token for accessing this file.

Returns:

  • []



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/appwrite/services/storage.rb', line 553

def get_file_view(bucket_id:, file_id:, token: nil)
    api_path = '/storage/buckets/{bucketId}/files/{fileId}/view'
        .gsub('{bucketId}', bucket_id)
        .gsub('{fileId}', file_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    if file_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "fileId"')
    end

    api_params = {
        token: token,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "accept": '*/*',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#list_buckets(queries: nil, search: nil, total: nil) ⇒ BucketList

Get a list of all the storage buckets. You can use the query params to filter your results.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (BucketList) 


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

def list_buckets(queries: nil, search: nil, total: nil)
    api_path = '/storage/buckets'

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "accept": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::BucketList
    )

end

#list_files(bucket_id:, queries: nil, search: nil, total: nil) ⇒ FileList

Get a list of all the user files. You can use the query params to filter your results.

Parameters:

  • bucket_id (String) —

    Storage bucket unique ID. You can create a new storage bucket using the Storage service server integration.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (FileList) 


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/appwrite/services/storage.rb', line 225

def list_files(bucket_id:, queries: nil, search: nil, total: nil)
    api_path = '/storage/buckets/{bucketId}/files'
        .gsub('{bucketId}', bucket_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "accept": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::FileList
    )

end

#update_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil, transformations: nil) ⇒ Bucket

Update a storage bucket by its unique ID.

Parameters:

  • bucket_id (String) —

    Bucket unique ID.

  • name (String) —

    Bucket name

  • permissions (Array) (defaults to: nil) —

    An array of permission strings. By default, the current permissions are inherited. Learn more about permissions.

  • [] —

    file_security Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. Learn more about permissions.

  • [] —

    enabled Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.

  • maximum_file_size (Integer) (defaults to: nil) —

    Maximum file size allowed in bytes. Maximum allowed value is 5GB.

  • allowed_file_extensions (Array) (defaults to: nil) —

    Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.

  • compression (Compression) (defaults to: nil) —

    Compression algorithm chosen for compression. Can be one of none, gzip, or zstd, For file size above 20MB compression is skipped even if it's enabled

  • [] —

    encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled

  • [] —

    antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled

  • [] —

    transformations Are image transformations enabled?

Returns:

  • (Bucket) 


145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/appwrite/services/storage.rb', line 145

def update_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil, transformations: nil)
    api_path = '/storage/buckets/{bucketId}'
        .gsub('{bucketId}', bucket_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

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

    api_params = {
        name: name,
        permissions: permissions,
        fileSecurity: file_security,
        enabled: enabled,
        maximumFileSize: maximum_file_size,
        allowedFileExtensions: allowed_file_extensions,
        compression: compression,
        encryption: encryption,
        antivirus: antivirus,
        transformations: transformations,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
        "accept": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Bucket
    )

end

#update_file(bucket_id:, file_id:, name: nil, permissions: nil) ⇒ File

Update a file by its unique ID. Only users with write permissions have access to update this resource.

Parameters:

  • bucket_id (String) —

    Bucket unique ID.

  • file_id (String) —

    File ID.

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

    File name.

  • permissions (Array) (defaults to: nil) —

    An array of permission strings. By default, the current permissions are inherited. Learn more about permissions.

Returns:

  • (File) 


369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/appwrite/services/storage.rb', line 369

def update_file(bucket_id:, file_id:, name: nil, permissions: nil)
    api_path = '/storage/buckets/{bucketId}/files/{fileId}'
        .gsub('{bucketId}', bucket_id)
        .gsub('{fileId}', file_id)

    if bucket_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
    end

    if file_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "fileId"')
    end

    api_params = {
        name: name,
        permissions: permissions,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
        "accept": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::File
    )

end