firebase::storage::StorageListResult

#include <list_result.h>

Contains the prefixes and items returned by a StorageReference::List call.

Summary

Constructors and Destructors
StorageListResult()
Default constructor. This creates an invalid StorageListResult.
StorageListResult(const StorageListResult & other)
Copy constructor.
StorageListResult(StorageListResult && other)
Move constructor.
~StorageListResult()
Destructor.

Public functions
is_valid() const
bool
Returns true if this StorageListResult is valid, false if it is not valid.
items() const
const std::vector< StorageReference > &
Returns the items (files) returned by the List operation.
next_page_token() const
const std::string &
Returns a token that can be used to resume a previous List operation.
operator=(const StorageListResult & other)
Copy assignment operator.
operator=(StorageListResult && other)
Move assignment operator.
prefixes() const
const std::vector< StorageReference > &
Returns the prefixes (folders) returned by the List operation.

Public functions

StorageListResult

 StorageListResult()

Default constructor. This creates an invalid StorageListResult.

StorageListResult

 StorageListResult(
  const StorageListResult & other
)

Copy constructor.

Details
Parameters
other
StorageListResult to copy from.

StorageListResult

 StorageListResult(
  StorageListResult && other
)

Move constructor.

Details
Parameters
other
StorageListResult to move data from.

is_valid

bool is_valid() const

Returns true if this StorageListResult is valid, false if it is not valid.

items

const std::vector< StorageReference > & items() const

Returns the items (files) returned by the List operation.

Details
Returns
A list of items (files).

next_page_token

const std::string & next_page_token() const

Returns a token that can be used to resume a previous List operation.

Details
Returns
A page token if more results are available, or an empty string if there are no more results.

operator=

StorageListResult & operator=(
  const StorageListResult & other
)

Copy assignment operator.

Details
Parameters
other
StorageListResult to copy from.
Returns
Reference to the destination StorageListResult.

operator=

StorageListResult & operator=(
  StorageListResult && other
)

Move assignment operator.

Details
Parameters
other
StorageListResult to move data from.
Returns
Reference to the destination StorageListResult.

prefixes

const std::vector< StorageReference > & prefixes() const

Returns the prefixes (folders) returned by the List operation.

Details
Returns
A list of prefixes (folders).

~StorageListResult

 ~StorageListResult()

Destructor.