https://github.com/operatorfoundation/capacitor-plugin-moonbounce
Capacitor Plugin For the Android Moonbounce Library
https://github.com/operatorfoundation/capacitor-plugin-moonbounce
Last synced: 8 months ago
JSON representation
Capacitor Plugin For the Android Moonbounce Library
- Host: GitHub
- URL: https://github.com/operatorfoundation/capacitor-plugin-moonbounce
- Owner: OperatorFoundation
- Created: 2023-03-24T20:49:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-12T19:18:42.000Z (almost 3 years ago)
- Last Synced: 2025-10-01T06:51:29.774Z (8 months ago)
- Language: Kotlin
- Size: 155 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# capacitor-plugin-moonbounce
A Capacitor plugin for the Moonbounce VPN library.
## Install
```bash
npm install capacitor-plugin-moonbounce
npx cap sync
```
## API
* [`checkPermissions()`](#checkpermissions)
* [`requestPermissions()`](#requestpermissions)
* [`startVPN(...)`](#startvpn)
* [`stopVPN()`](#stopvpn)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
### checkPermissions()
```typescript
checkPermissions() => Promise
```
**Returns:** Promise<PermissionStatus>
--------------------
### requestPermissions()
```typescript
requestPermissions() => Promise
```
**Returns:** Promise<PermissionStatus>
--------------------
### startVPN(...)
```typescript
startVPN(options: { serverIP: string; serverPort: number; disallowedApp: string; excludeIP: string; }) => Promise
```
| Param | Type |
| ------------- | ------------------------------------------------------------------------------------------------ |
| **`options`** | { serverIP: string; serverPort: number; disallowedApp: string; excludeIP: string; } |
--------------------
### stopVPN()
```typescript
stopVPN() => Promise
```
--------------------
### Interfaces
#### PermissionStatus
| Prop | Type |
| ------------------- | ----------------------------------------------------------- |
| **`vpnConnection`** | PermissionState |
### Type Aliases
#### PermissionState
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'