docs(api): 添加Refresh示例

wlist-org · Jun 11, 2024 · c2863bc · c2863bc
1 parent 65b854c
commit c2863bc
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/src/com/xuxiaocheng/wlist/api/core/files/Refresh.java b/src/com/xuxiaocheng/wlist/api/core/files/Refresh.java
@@ -11,6 +11,22 @@
 /**
  * The core refresh API.
  * Only after refreshing, the files/directories are indexed.
+ * <p>For example: <pre> {@code
+ * final RefreshConfirmation confirmation = Refresh.refresh(client, token, location).get();
+ * Refresh.confirm(client, confirmation.token()).get();
+ * while (true) {
+ *   try {
+ *     final RefreshProgress ignoredProgress = Refresh.progress(client, confirmation.token()).get();
+ *     TimeUnit.SECONDS.sleep(1);
+ *   } catch (final ExecutionException exception) {
+ *     if (exception.getCause() instanceof TokenExpiredException)
+ *       break;
+ *     throw exception;
+ *   }
+ * }
+ * final boolean finished = Refresh.check(client, confirmation.token()).get();
+ * // Assertions.assertTrue(finished);
+ * }</pre>
  */
 public enum Refresh {;
     /**