Skip to content

Commit f14e294

Browse files
committed
update android storage api with options list
1 parent c6ee9af commit f14e294

File tree

4 files changed

+30
-3
lines changed

4 files changed

+30
-3
lines changed

src/pages/[platform]/build-a-backend/storage/download-files/index.mdx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,13 +237,14 @@ RxAmplify.Storage.getUrl(StoragePath.fromString("public/example"), options).subs
237237
</Block>
238238
</BlockSwitcher>
239239

240-
### More `getURL` options
240+
### All `getURL` options
241241

242242
Option | Type | Description |
243243
| -- | -- | ----------- |
244-
| bucket | StorageBucket | A string representing the target bucket's assigned name in Amplify Backend or an object specifying the bucket name and region from the console.<br/><br/>Read more at [Configure additional storage buckets](/[platform]/build-a-backend/storage/set-up-storage/#configure-additional-storage-buckets) |
244+
| bucket | StorageBucket | The bucket in which the object is stored |
245245
| expires | Integer | Number of seconds before the URL expires |
246246
| useAccelerateEndpoint | Boolean | Flag to configure use of acceleration mode |
247+
| validateObjectExistence | Boolean | Flag to check if the file exists |
247248

248249
</InlineFilter>
249250

@@ -929,6 +930,12 @@ download
929930
</Block>
930931
</BlockSwitcher>
931932

933+
### All `download` options
934+
935+
| Option | Type | Description |
936+
| --- | --- | --- |
937+
| bucket | StorageBucket | The bucket in which the object is stored |
938+
932939
</InlineFilter>
933940

934941
<InlineFilter filters={["flutter"]}>

src/pages/[platform]/build-a-backend/storage/list-files/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -728,11 +728,13 @@ Path: public/photos/2024/photos02.jpg
728728
Subpath: public/photos/202-
729729
```
730730

731-
### More `list` options
731+
### All `list` options
732732

733733
| Option | Type | Description |
734734
| --- | --- | --- |
735+
| subpathStrategy | SubpathStrategy | The strategy to use when listing contents from subpaths |
735736
| pageSize | int | Number between 1 and 1,000 that indicates the limit of how many entries to fetch when retrieving file lists from the server |
737+
| bucket | StorageBucket | The bucket in which the objects are stored |
736738
| nextToken | String | String indicating the page offset at which to resume a listing. |
737739

738740

src/pages/[platform]/build-a-backend/storage/remove-files/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,12 @@ RxAmplify.Storage.remove(StoragePath.fromString("public/myUploadedFileName.txt")
264264
</Block>
265265
</BlockSwitcher>
266266

267+
### All `remove` options
268+
269+
Option | Type | Description |
270+
| -- | -- | ----------- |
271+
| bucket | StorageBucket | The bucket in which the object is stored |
272+
267273
</InlineFilter>
268274

269275
<InlineFilter filters={["swift"]}>

src/pages/[platform]/build-a-backend/storage/upload-files/index.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1180,6 +1180,18 @@ upload
11801180

11811181
<InlineFilter filters={["android"]}>
11821182

1183+
### All `upload` options
1184+
1185+
Option | Type | Description |
1186+
| -- | -- | ----------- |
1187+
| metadata | Map\<String\, String\> | Metadata for the object to store. |
1188+
| contentType | String | The standard MIME type describing the format of the object to store. |
1189+
| bucket | StorageBucket | The bucket in which the object should be stored |
1190+
1191+
</InlineFilter>
1192+
1193+
<InlineFilter filters={["android"]}>
1194+
11831195
### Query transfers
11841196

11851197
When an upload or download operation is requested using the Amplify Android library, the request is first persisted in the local SQLite Database and then queued for execution. You can query the transfer operation queued in the local database using the transfer ID returned by an upload or download API. Get-Transfer API could retrieve a pending transfer previously en-queued and enable attaching a listener to receive updates on progress change, on-error or on-success, or pause, cancel or resume it.

0 commit comments

Comments
 (0)