WaitTask extension

on

Methods

waitAppTask({required int taskID, WaitParams params = const WaitParams(), RequestOptions? requestOptions}) → Future<void>

Available on SearchClient, provided by the WaitTask extension

Wait for an application-level taskID to complete before executing the next line of code.
waitKeyCreation({required String key, int maxRetries = 50, WaitParams params = const WaitParams(), RequestOptions? requestOptions}) → Future<void>

Available on SearchClient, provided by the WaitTask extension

Wait on an API key creation operation.
waitKeyDeletion({required String key, WaitParams params = const WaitParams(), RequestOptions? requestOptions}) → Future<void>

Available on SearchClient, provided by the WaitTask extension

Wait on a delete API ket operation.
waitKeyUpdate({required String key, required ApiKey apiKey, WaitParams params = const WaitParams(), RequestOptions? requestOptions}) → Future<void>

Available on SearchClient, provided by the WaitTask extension

Wait on an API key update operation.
waitTask({required String indexName, required int taskID, WaitParams params = const WaitParams(), RequestOptions? requestOptions}) → Future<void>

Available on SearchClient, provided by the WaitTask extension

Wait for a taskID to complete before executing the next line of code, to synchronize index updates. All write operations in Algolia are asynchronous by design. It means that when you add or update an object to your index, our servers will reply to your request with a taskID as soon as they understood the write operation. The actual insert and indexing will be done after replying to your code. You can wait for a task to complete by using the taskID and this method.