@capawesome/capacitor-managed-configurations
TypeScript icon, indicating that this package has built-in type declarations

6.0.0 • Public • Published

@capawesome/capacitor-managed-configurations

Capacitor plugin to access managed configuration settings.

Installation

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

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(...)

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 on 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 on 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 on 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.

Credits

This plugin is based on the Capacitor Managed Configurations plugin. Thanks to everyone who contributed to the project!

Readme

Keywords

Package Sidebar

Install

npm i @capawesome/capacitor-managed-configurations

Weekly Downloads

293

Version

6.0.0

License

MIT

Unpacked Size

31.7 kB

Total Files

28

Last publish

Collaborators

  • robingenz