Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/logseq/capacitor-file-sync
Logseq Sync capacitor plugin for iOS and Android
https://github.com/logseq/capacitor-file-sync
Last synced: 3 months ago
JSON representation
Logseq Sync capacitor plugin for iOS and Android
- Host: GitHub
- URL: https://github.com/logseq/capacitor-file-sync
- Owner: logseq
- Created: 2022-09-15T16:23:07.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-25T07:49:10.000Z (10 months ago)
- Last Synced: 2024-05-23T04:24:15.149Z (6 months ago)
- Language: Swift
- Homepage:
- Size: 78.5 MB
- Stars: 5
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-starred - logseq/capacitor-file-sync - Logseq Sync capacitor plugin for iOS and Android (others)
README
# @logseq/capacitor-file-sync
Logseq Sync for mobile platforms.
## Local Development
```bash
# run the following in capacitor-file-sync/ folder
yarn link
# run the following in logseq/ folder
yarn link @logseq/capacitor-file-sync
```
## Install
```bash
npm install @logseq/capacitor-file-sync
npx cap sync
```
## API Doc
* [`keygen()`](#keygen)
* [`setEnv(...)`](#setenv)
* [`encryptFnames(...)`](#encryptfnames)
* [`decryptFnames(...)`](#decryptfnames)
* [`getLocalFilesMeta(...)`](#getlocalfilesmeta)
* [`getLocalAllFilesMeta(...)`](#getlocalallfilesmeta)
* [`deleteLocalFiles(...)`](#deletelocalfiles)
* [`fetchRemoteFiles(...)`](#fetchremotefiles)
* [`updateLocalFiles(...)`](#updatelocalfiles)
* [`updateLocalVersionFiles(...)`](#updatelocalversionfiles)
* [`deleteRemoteFiles(...)`](#deleteremotefiles)
* [`updateRemoteFiles(...)`](#updateremotefiles)
* [`encryptWithPassphrase(...)`](#encryptwithpassphrase)
* [`decryptWithPassphrase(...)`](#decryptwithpassphrase)
* [`cancelAllRequests(...)`](#cancelallrequests)
### keygen()
```typescript
keygen() => Promise<{ secretKey: string; publicKey: string; }>
```
**Returns:** Promise<{ secretKey: string; publicKey: string; }>
--------------------
### setEnv(...)
```typescript
setEnv(options: { graphUUID: string; env: string; secretKey: string; publicKey: string; }) => Promise
```
| Param | Type |
| ------------- | -------------------------------------------------------------------------------------- |
| **`options`** | { graphUUID: string; env: string; secretKey: string; publicKey: string; } |
--------------------
### encryptFnames(...)
```typescript
encryptFnames(options: { graphUUID: string; filePaths: string[]; }) => Promise<{ value: string[]; }>
```
| Param | Type |
| ------------- | -------------------------------------------------------- |
| **`options`** | { graphUUID: string; filePaths: string[]; } |
**Returns:** Promise<{ value: string[]; }>
--------------------
### decryptFnames(...)
```typescript
decryptFnames(options: { graphUUID: string; filePaths: string[]; }) => Promise<{ value: string[]; }>
```
| Param | Type |
| ------------- | -------------------------------------------------------- |
| **`options`** | { graphUUID: string; filePaths: string[]; } |
**Returns:** Promise<{ value: string[]; }>
--------------------
### getLocalFilesMeta(...)
```typescript
getLocalFilesMeta(options: { graphUUID: string; basePath: string; filePaths: string[]; }) => Promise<{ result: any[]; }>
```
| Param | Type |
| ------------- | -------------------------------------------------------------------------- |
| **`options`** | { graphUUID: string; basePath: string; filePaths: string[]; } |
**Returns:** Promise<{ result: any[]; }>
--------------------
### getLocalAllFilesMeta(...)
```typescript
getLocalAllFilesMeta(options: { graphUUID: string; basePath: string; }) => Promise<{ result: any[]; }>
```
| Param | Type |
| ------------- | ----------------------------------------------------- |
| **`options`** | { graphUUID: string; basePath: string; } |
**Returns:** Promise<{ result: any[]; }>
--------------------
### deleteLocalFiles(...)
```typescript
deleteLocalFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; }) => Promise
```
| Param | Type |
| ------------- | -------------------------------------------------------------------------- |
| **`options`** | { graphUUID: string; basePath: string; filePaths: string[]; } |
--------------------
### fetchRemoteFiles(...)
```typescript
fetchRemoteFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; token: string; }) => Promise
```
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------- |
| **`options`** | { graphUUID: string; basePath: string; filePaths: string[]; token: string; } |
--------------------
### updateLocalFiles(...)
```typescript
updateLocalFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; token: string; }) => Promise
```
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------- |
| **`options`** | { graphUUID: string; basePath: string; filePaths: string[]; token: string; } |
--------------------
### updateLocalVersionFiles(...)
```typescript
updateLocalVersionFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; token: string; }) => Promise
```
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------- |
| **`options`** | { graphUUID: string; basePath: string; filePaths: string[]; token: string; } |
--------------------
### deleteRemoteFiles(...)
```typescript
deleteRemoteFiles(options: { graphUUID: string; filePaths: string[]; token: string; txid: number; }) => Promise<{ txid: number; }>
```
| Param | Type |
| ------------- | ------------------------------------------------------------------------------------- |
| **`options`** | { graphUUID: string; filePaths: string[]; token: string; txid: number; } |
**Returns:** Promise<{ txid: number; }>
--------------------
### updateRemoteFiles(...)
```typescript
updateRemoteFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; token: string; txid: number; }) => Promise<{ txid: number; }>
```
| Param | Type |
| ------------- | ------------------------------------------------------------------------------------------------------- |
| **`options`** | { graphUUID: string; basePath: string; filePaths: string[]; token: string; txid: number; } |
**Returns:** Promise<{ txid: number; }>
--------------------
### encryptWithPassphrase(...)
```typescript
encryptWithPassphrase(options: { passphrase: string; content: string; }) => Promise<{ data: string; }>
```
| Param | Type |
| ------------- | ----------------------------------------------------- |
| **`options`** | { passphrase: string; content: string; } |
**Returns:** Promise<{ data: string; }>
--------------------
### decryptWithPassphrase(...)
```typescript
decryptWithPassphrase(options: { passphrase: string; content: string; }) => Promise<{ data: string; }>
```
| Param | Type |
| ------------- | ----------------------------------------------------- |
| **`options`** | { passphrase: string; content: string; } |
**Returns:** Promise<{ data: string; }>
--------------------
### cancelAllRequests(...)
```typescript
cancelAllRequests(options: unknown) => Promise
```
| Param | Type |
| ------------- | -------------------- |
| **`options`** | unknown |
--------------------