capacitor-native-settings

Capacitor plugin to open native settings screens for android and iOS

Install

npm install @trieutulong/capacitor-native-settings
npx cap sync

API

• openAndroid(...)
• openIOS(...)
• Interfaces
• Enums

openAndroid(...)

openAndroid(option: AndroidOptions) => any

Opens the specified option in android.

| Param | Type | Description | | ------------ | --------------------------------------------------------- | -------------------------------------------- | | option | AndroidOptions | AndroidOptions |

Returns: any

openIOS(...)

openIOS(option: IOSOptions) => any

Opens the specified option in android.

| Param | Type | Description | | ------------ | ------------------------------------------------- | ------------------------------------ | | option | IOSOptions | IOSOptions |

Returns: any

Interfaces

AndroidOptions

| Prop | Type | | ------------ | ----------------------------------------------------------- | | option | AndroidSettings |

IOSOptions

| Prop | Type | | ------------ | --------------------------------------------------- | | option | IOSSettings |

Enums

AndroidSettings

| Members | Value | Description | | ---------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------ | | Accessibility | 'accessibility' | Show settings for accessibility modules | | Account | 'account' | Show add account screen for creating a new account | | AirplaneMode | 'airplane_mode' | Show settings to allow entering/exiting airplane mode | | Apn | 'apn' | Show settings to allow configuration of APNs | | ApplicationDetails | 'application_details' | Show screen of details about a particular application | | ApplicationDevelopment | 'application_development' | Show settings to allow configuration of application development-related settings | | Application | 'application' | Show settings to allow configuration of application-related settings | | BatteryOptimization | 'battery_optimization' | Show screen for controlling which apps can ignore battery optimizations | | Bluetooth | 'bluetooth' | Show settings to allow configuration of Bluetooth | | Captioning | 'captioning' | Show settings for video captioning | | Cast | 'cast' | Show settings to allow configuration of cast endpoints | | DataRoaming | 'data_roaming' | Show settings for selection of 2G/3G/4G | | Date | 'date' | Show settings to allow configuration of date and time | | Display | 'display' | Show settings to allow configuration of display | | Dream | 'dream' | Show Daydream settings | | Home | 'home' | Show Home selection settings | | Keyboard | 'keyboard' | Show settings to configure input methods, in particular allowing the user to enable input methods | | KeyboardSubType | 'keyboard_subtype' | Show settings to enable/disable input method subtypes | | Locale | 'locale' | Show settings to allow configuration of locale | | Location | 'location' | Show settings to allow configuration of current location sources | | ManageApplications | 'manage_applications' | Show settings to manage installed applications | | ManageAllApplications | 'manage_all_applications' | Show settings to manage all applications | | MemoryCard | 'memory_card' | Show settings for memory card storage | | Network | 'network' | Show settings for selecting the network operator | | NfcSharing | 'nfcsharing' | Show NFC Sharing settings | | NfcPayment | 'nfc_payment' | Show NFC Tap & Pay settings | | NfcSettings | 'nfc_settings' | Show NFC settings | | Print | 'print' | Show the top level print settings | | Privacy | 'privacy' | Show settings to allow configuration of privacy options | | QuickLaunch | 'quick_launch' | Show settings to allow configuration of quick launch shortcuts | | Search | 'search' | Show settings for global search | | Security | 'security' | Show settings to allow configuration of security and location privacy | | Settings | 'settings' | Show system settings | | ShowRegulatoryInfo | 'show_regulatory_info' | Show the regulatory information screen for the device | | Sound | 'sound' | Show settings to a llow configuration of sound and volume | | Storage | 'storage' | Show settings for internal storage | | Sync | 'sync' | Show settings to allow configuration of sync settings | | Usage | 'usage' | Show settings to control access to usage information | | UserDictionary | 'user_dictionary' | Show settings to manage the user input dictionary | | VoiceInput | 'voice_input' | Show settings to configure input methods, in particular allowing the user to enable input methods | | Wifi | 'wifi' | Show settings to allow configuration of Wi-Fi | | WifiIp | 'wifi_ip' | Show settings to allow configuration of a static IP address for Wi-Fi | | Wireless | 'wireless' | Show settings to allow configuration of wireless controls such as Wi-Fi, Bluetooth and Mobile networks |

IOSSettings

| Members | Value | Description | | ------------- | ---------------------- | ---------------------------------------- | | General | 'general' | Opens iOS' general settings screen. | | App | 'app' | Opens your app-specific settings screen. |