ListResult

public final class ListResult

Contains the prefixes and items returned by a list call.

Summary

Public fields
final List<StorageReference>
final @Nullable String
final List<StorageReference>

Public methods
@NonNull List<StorageReference>

The items (files) returned by the list() operation.
@Nullable String

Returns a token that can be used to resume a previous list() operation.
@NonNull List<StorageReference>

The prefixes (folders) returned by the list() operation.

Extension functions
final @NonNull List<@NonNull StorageReference>

Destructuring declaration for ListResult to provide its items.
final @NonNull List<@NonNull StorageReference>

This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
final @NonNull List<@NonNull StorageReference>

Destructuring declaration for ListResult to provide its prefixes.
final @NonNull List<@NonNull StorageReference>

This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
final String

Destructuring declaration for ListResult to provide its pageToken.
final String

This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

Public fields

items

public final List<StorageReference> items

pageToken

public final @Nullable String pageToken

prefixes

public final List<StorageReference> prefixes

Public methods

getItems

public @NonNull List<StorageReference> getItems()

The items (files) returned by the list() operation.

Returns
@NonNull List<StorageReference>

A list of items (files).

getPageToken

public @Nullable String getPageToken()

Returns a token that can be used to resume a previous list() operation. null indicates that there are no more results.

Returns
@Nullable String

A page token if more results are available.

getPrefixes

public @NonNull List<StorageReference> getPrefixes()

The prefixes (folders) returned by the list() operation.

Returns
@NonNull List<StorageReference>

A list of prefixes (folders).

Extension functions

StorageKt.component1

public final @NonNull List<@NonNull StorageReference> StorageKt.component1(@NonNull ListResult receiver)

Destructuring declaration for ListResult to provide its items.

Returns
@NonNull List<@NonNull StorageReference>

the items of the ListResult

StorageKt.component1

public final @NonNull List<@NonNull StorageReference> StorageKt.component1(@NonNull ListResult receiver)

Destructuring declaration for ListResult to provide its items.

Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.

Returns
@NonNull List<@NonNull StorageReference>

the items of the ListResult

StorageKt.component2

public final @NonNull List<@NonNull StorageReference> StorageKt.component2(@NonNull ListResult receiver)

Destructuring declaration for ListResult to provide its prefixes.

Returns
@NonNull List<@NonNull StorageReference>

the prefixes of the ListResult

StorageKt.component2

public final @NonNull List<@NonNull StorageReference> StorageKt.component2(@NonNull ListResult receiver)

Destructuring declaration for ListResult to provide its prefixes.

Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.

Returns
@NonNull List<@NonNull StorageReference>

the prefixes of the ListResult

StorageKt.component3

public final String StorageKt.component3(@NonNull ListResult receiver)

Destructuring declaration for ListResult to provide its pageToken.

Returns
String

the pageToken of the ListResult

StorageKt.component3

public final String StorageKt.component3(@NonNull ListResult receiver)

Destructuring declaration for ListResult to provide its pageToken.

Deprecation Notice: The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in com.google.firebase.firebase-storage-ktx are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the FAQ about this initiative.

Returns
String

the pageToken of the ListResult