capawesome-team/capacitor-managed-configurations

⚡️ Capacitor plugin to access managed configuration settings.

⚠️ Deprecated repository

This project has been moved to the following monorepo: capawesome-team/capacitor-plugins.

---

Managed Configuration

@capawesome/capacitor-managed-configurations

Capacitor plugin to access managed configuration settings.

Maintainers

Maintainer	GitHub	Social
Robin Genz	robingenz	@robin_genz

Sponsors

This is an MIT-licensed open source project. It can grow thanks to the support by these awesome people. If you'd like to join them, please read more here.

Installation

npm install @capawesome/capacitor-managed-configurations
npx cap sync

On Android, see Define managed configurations and follow the instructions to declare the app's managed configurations correctly.

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-plugin-demo

Usage

import { ManagedConfigurations } from '@capawesome/capacitor-managed-configurations';

const getString = async () => {
  const result = await ManagedConfigurations.getString({ key: 'server_url' });
  return result.value;
};

const getNumber = async () => {
  const result = await ManagedConfigurations.getNumber({ key: 'server_port' });
  return result.value;
};

const getBoolean = async () => {
  const result = await ManagedConfigurations.getBoolean({ key: 'download_on_cellular' });
  return result.value;
};

API

• getString(...)
• getNumber(...)
• getBoolean(...)
• Interfaces

getString(...)

getString(options: GetOptions) => Promise<GetResult<string>>

Fetches the value associated with the given key, or null if no mapping exists for the given key.

Only available for Android and iOS.

Param	Type
options	GetOptions

Returns: Promise<GetResult<string>>

---

getNumber(...)

getNumber(options: GetOptions) => Promise<GetResult<number>>

Fetches the value associated with the given key, or null if no mapping exists for the given key.

Only available for Android and iOS.

Param	Type
options	GetOptions

Returns: Promise<GetResult<number>>

---

getBoolean(...)

getBoolean(options: GetOptions) => Promise<GetResult<boolean>>

Fetches the value associated with the given key, or null if no mapping exists for the given key.

Only available for Android and iOS.

Param	Type
options	GetOptions

Returns: Promise<GetResult<boolean>>

---

Interfaces

GetResult

Prop	Type	Description
value	T | null	The value of the configuration entry, or null if no mapping exists for the given key.

GetOptions

Prop	Type	Description
key	string	Unique key for the configuration entry.

Test your implementation

On Android, see Set up device owner for testing and follow the instructions to set up a device owner testing environment.

On iOS, you need to install the app as a managed app with a MDM solution.

Changelog

See CHANGELOG.md.

License

See LICENSE.

capacitor-managed-configurations's Issues

feat: add iOS support

Is your feature request related to a problem? Please describe:

iOS is currently not supported.

Describe the solution you'd like:

Add iOS support.

Describe alternatives you've considered:

Additional context:

https://stackoverflow.com/questions/20752254/using-mdm-to-configure-an-enterprise-app-via-nsuserdefaults

docs: add method descriptions

bug(ios): `undefined` is returned instead of `null`

Current behavior:

Fetches the value associated with the given key, or null if no mapping exists for the given key.

This is wrong. On iOS, undefined is currently returned.

Expected behavior:

It should return null as described.