@robingenz/capacitor-managed-configurations v0.1.4

Maintainers

Installation

npm install @robingenz/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.

Usage

import { ManagedConfigurations } from '@robingenz/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>>

Returns: Promise<GetResult<string>>

getNumber(...)

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

Returns: Promise<GetResult<number>>

getBoolean(...)

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

Returns: Promise<GetResult<boolean>>

Interfaces

GetResult

GetOptions

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 using an MDM solution.

Changelog

See CHANGELOG.md.

License

See LICENSE.