@mattermost/react-native-emm

@mattermost/react-native-emm

A React Native Module for EMM managed configurations

Table of Contents

* Installation
* iOS
* Android
* Usage

Installation

Using npm:

``shell
npm install --save-exact @mattermost/react-native-emm
`

or using yarn:

`shell
yarn add -E @mattermost/react-native-emm
`

Then follow the instructions for your platform to link @mattermost/react-native-emm into your project:

$3

$3

Usage

`javascript
// Load the module
import Emm from '@mattermost/react-native-emm';
`

$3

#### addListener
addListener(callback: ManagedConfigCallBack): EmitterSubscription;

Event used to listen for Managed Configuration changes while the app is running.

Example:
`js
useEffect(() => {
const listener = Emm.addListener((config: AuthenticateConfig) => {
setManaged(config);
});

return () => {
listener.remove();
};
});
`

Note: Don't forget to remove the listener when no longer needed to avoid memory leaks.

#### authenticate
authenticate(opts: AuthenticateConfig): Promise

Request the user to authenticate using one of the device built-in authentication methods. You should call this after verifying that the device is secure

Example:
`js
const opts: AuthenticateConfig = {
reason: 'Some Reason',
description: 'Some Description',
fallback: true,
supressEnterPassword: true,
};
const authenticated = await Emm.authenticate(opts);
`

Platforms: All

#### deviceSecureWith
deviceSecureWith(): Promise

Get available device authentication methods.

Example:
`js
const optionsAvailable: AuthenticationMethods = await Emm.deviceSecureWith()
`

Platforms: All

#### enableBlurScreen
enableBlurScreen(enabled: boolean): void

iOS: Blurs the application screen in the App Switcher view
Android: Blanks the application screen in the Task Manager

Example:
`
Emm.enableBlurScreen(true);
`

Platforms: All

#### exitApp
exitApp(): void

Forces the app to exit.

Example:
`
Emm.exitApp();
`
Platforms: All

#### getManagedConfig
getManagedConfig(): Promise>

Retrieves the Managed Configuration set by the Enterprise Mobility Management provider.

Notes:
Android uses the Restriction Manager to set the managed configuration settings and values while iOS uses NSUserDefaults under the key com.apple.configuration.managed

Example:
`
const manged: Record = Emm.getManagedConfig(); // Managed configuration object containing keys and values
`

Platforms: all

##### isDeviceSecured
isDeviceSecured(): Promise

Determines if the device has at least one authentication method enabled.

Example:
`
const secured = await Emm.isDeviceSecured();
`
Platforms: All

##### openSecuritySettings
openSecuritySettings(): void

If the device is not secured, you can use this function to take the user to the Device Security Settings to set up an authentication method.

Example:
`
Emm.openSecuritySettings();
`

Note: This function will close the running application.

Platforms: Android

##### setAppGroupId
setAppGroupId(identifier: string): void

At times you may built an iOS extension application (ex: Share Extension / Notification Extension), if you need access to the Managed Configuration you should set this value to your App Group Identifier). This will create a copy of the managed configuration found in NSUserDefaults under the key com.apple.configuration.managed to a shared NSUserDefaults with your App Group identifier under the same key.

Example:
`
Emm.setAppGroupId('group.com.example.myapp);
``
Platforms: iOS

TODOS

- [ ] Android: Use BiometricPrompt when available
---

MIT Licensed