Skip to content

storage.md

Latest commit

 

History

History
408 lines (236 loc) · 14 KB

storage.md

File metadata and controls

408 lines (236 loc) · 14 KB

Storage

Description

Firebase Storage class

class Storage

Functions

  1. 🔹 void url(const String &url)

Set the Firebase Storage URL

void url(const String &url)

Params:

  • url - The Firebase Storage URL.

  1. 🔹 void loop()

Perform the async task repeatedly. Should be places in main loop function.

void loop()

  1. 🔹 bool download(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file)

The bucketid is the Storage bucket Id of object to download. The object is the object in Storage bucket to download. The access token is the Firebase Storage's file access token which used only for priviledge file download access in non-authentication mode (NoAuth).

bool download(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id, object and/or access token in its constructor.
  • file - The filesystem data (file_config_data) obtained from FileConfig class object.

Returns:

  • Boolean value, indicates the success of the operation.

  1. 🔹 void download(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, AsyncResult &aResult)

The bucketid is the Storage bucket Id of object to download. The object is the object in Storage bucket to download. The access token is the Firebase Storage's file access token which used only for priviledge file download access in non-authentication mode (NoAuth).

void download(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, AsyncResult &aResult)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id, object and/or access token in its constructor.
  • file - The filesystem data (file_config_data) obtained from FileConfig class object.
  • aResult - The async result (AsyncResult).

  1. 🔹 void download(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, AsyncResultCallback cb, const String &uid = "")

The bucketid is the Storage bucket Id of object to download. The object is the object in Storage bucket to download. The access token is the Firebase Storage's file access token which used only for priviledge file download access in non-authentication mode (NoAuth).

void download(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, AsyncResultCallback cb, const String &uid = "")

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id, object and/or access token in its constructor.
  • file - The filesystem data (file_config_data) obtained from FileConfig class object.
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).

  1. 🔹 bool upload(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, const String &mime)

The bucketid is the Storage bucket Id of object to upload. The object is the object to be stored in the Storage bucket. The access token is the Firebase Storage's file access token which used only for priviledge file download access in non-authentication mode (NoAuth).

bool upload(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, const String &mime)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id and object in its constructor.
  • file - The filesystem data (file_config_data) obtained from FileConfig class object.
  • mime - The file MIME type

Returns:

  • Boolean value, indicates the success of the operation.

  1. 🔹 void upload(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, const String &mime, AsyncResult &aResult)

The bucketid is the Storage bucket Id of object to upload. The object is the object to be stored in the Storage bucket.

void upload(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, const String &mime, AsyncResult &aResult)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id and object in its constructor.
  • file - The filesystem data (file_config_data) obtained from FileConfig class object.
  • mime - The file MIME type
  • aResult - The async result (AsyncResult).

  1. 🔹 void upload(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, const String &mime, AsyncResultCallback cb, const String &uid = "")

The bucketid is the Storage bucket Id of object to upload. The object is the object to be stored in the Storage bucket.

void upload(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, file_config_data &file, const String &mime, AsyncResultCallback cb, const String &uid = "")

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id, object and/or access token in its constructor.
  • file - The filesystem data (file_config_data) obtained from FileConfig class object.
  • mime - The file MIME type
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).

  1. 🔹 bool ota(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, int command = 0)

The bucketid is the Storage bucket Id of object to download. The object is the object in Storage bucket to download. The access token is the Firebase Storage's file access token which used only for priviledge file download access in non-authentication mode (NoAuth).

bool ota(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, int command = 0)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id, object and/or access token in its constructor.
  • command - The OTA command (optional). 0 or U_FLASH for firmware, 100 or U_FLASHFS (ESP32) or U_FS (ESP8266 or Raspberry Pi Pico), 101 or U_SPIFFS (ESP32), 102 for U_FATFS (ESP32), 103 or U_LITTLEFS (ESP32).

Returns:

  • Boolean value, indicates the success of the operation.

  1. 🔹 void ota(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResult &aResult, int command = 0)

The bucketid is the Storage bucket Id of object to download. The object is the object in Storage bucket to download. The access token is the Firebase Storage's file access token which used only for priviledge file download access in non-authentication mode (NoAuth).

void ota(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResult &aResult, int command = 0)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id, object and/or access token in its constructor.
  • aResult - The async result (AsyncResult).
  • command - The OTA command (optional). 0 or U_FLASH for firmware, 100 or U_FLASHFS (ESP32) or U_FS (ESP8266 or Raspberry Pi Pico), 101 or U_SPIFFS (ESP32), 102 for U_FATFS (ESP32), 103 or U_LITTLEFS (ESP32).

  1. 🔹 void ota(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResultCallback cb, const String &uid = "", int command = 0)

The bucketid is the Storage bucket Id of object to download. The object is the object in Storage bucket to download. The access token is the Firebase Storage's file access token which used only for priviledge file download access in non-authentication mode (NoAuth).

void ota(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResultCallback cb, const String &uid = "", int command = 0)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id, object and/or access token in its constructor.
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).
  • command - The OTA command (optional). 0 or U_FLASH for firmware, 100 or U_FLASHFS (ESP32) or U_FS (ESP8266 or Raspberry Pi Pico), 101 or U_SPIFFS (ESP32), 102 for U_FATFS (ESP32), 103 or U_LITTLEFS (ESP32).

  1. 🔹 String getMetadata(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent)

The bucketid is the Storage bucket Id of object to get metadata. The object is the object in Storage bucket to get metadata. The access token is the Firebase Storage's file access token which used only for priviledge file download access in non-authentication mode (NoAuth).

String getMetadata(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id and object in its constructor.

Returns:

  • String - The response payload.

  1. 🔹 void getMetadata(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResult &aResult)

The bucketid is the Storage bucket Id of object to get metadata. The object is the object in Storage bucket to get metadata.

void getMetadata(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResult &aResult)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id and object in its constructor.
  • aResult - The async result (AsyncResult).

  1. 🔹 void getMetadata(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResultCallback cb, const String &uid = "")

The bucketid is the Storage bucket Id of object to get metadata. The object is the object in Storage bucket to get metadata.

void getMetadata(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResultCallback cb, const String &uid = "")

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id and object in its constructor.
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).

  1. 🔹 String list(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent)

The bucketid is the Storage bucket Id to list all objects.

String list(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id in its constructor.

Returns:

  • String - The response payload.

  1. 🔹 void list(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResult &aResult)

The bucketid is the Storage bucket Id to list all objects.

void list(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResult &aResult)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id in its constructor.
  • aResult - The async result (AsyncResult).

  1. 🔹 void list(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResultCallback cb, const String &uid = "")

The bucketid is the Storage bucket Id to list all objects.

void list(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResultCallback cb, const String &uid = "")

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id in its constructor.
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).

  1. 🔹 bool deleteObject(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent)

The bucketid is the Storage bucket Id of object to delete. The object is the object in Storage bucket to delete.

bool deleteObject(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id and object in its constructor.

Returns:

  • Boolean value, indicates the success of the operation.

  1. 🔹 void deleteObject(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResult &aResult)

The bucketid is the Storage bucket Id of object to delete. The object is the object in Storage bucket to delete.

void deleteObject(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResult &aResult)

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id and object in its constructor.
  • aResult - The async result (AsyncResult).

  1. 🔹 void deleteObject(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResultCallback cb, const String &uid = "")

The bucketid is the Storage bucket Id of object to delete. The object is the object in Storage bucket to delete.

void deleteObject(AsyncClientClass &aClient, const FirebaseStorage::Parent &parent, AsyncResultCallback cb, const String &uid = "")

Params:

  • aClient - The async client.
  • parent - The FirebaseStorage::Parent object included Storage bucket Id and object in its constructor.
  • cb - The async result callback (AsyncResultCallback).
  • uid - The user specified UID of async result (optional).

  1. 🔹 void setOTAStorage(OTAStorage &storage)

Set Arduino OTA Storage.

void setOTAStorage(OTAStorage &storage)

Params:

  • storage - The Arduino OTAStorage class object.