Hardware Features

Biometric Authentication

Biometric authentication is a form of security that uses the biometric features of a user to identify and validate a user. Android and iOS both implement a form of this for user-identification.

Document Scanning

Using VisionKit in iOS, devices can leverage the built-in document scanner to upload documents to their Wisej application.

The Android version includes a custom implementation.

Haptic Feedback

Haptic feedback uses touch as a means to communicate with users. It applies forces, vibrations, or motions to the user.

Haptic Feedback Types

• Error: Play when a user performs an error.

• Success: Play when a user performs a successful action.

• Warning: Play when you want to warn the user of an action.

Near-field Communication (NFC)

Near-Field-Communication is a set of communication protocols that allows the communication of two electronic devices. This protocol is often used for contactless payment systems.‌

Sensors

As the system gathers information using various sensors on a device, the raw data can be monitored and used in the Wisej application.

Software Features

Audio

By default, iOS Safari does not allow auto-playing audio. The native integration disables this “feature”, so developers can play sounds on button clicks or any event after the first DOM interaction.

Native Popups

Native popups show users relevant in-app information that often request some form of feedback such as a selection or text entry.‌

Push Notifications

Push notifications are user-facing messages that display important information to the user about a specific application.‌

Permissions

When using certain device capabilities, it may be required to request the specified permission from the user of the device before proceeding.

Device Permission Types

• Camera: Required to use the device’s camera.

• Location: Required to access the device’s location.

• Microphone: Required to access the device’s microphone.

• Photos: Required to access the device’s photo library natively.

Screen Brightness

The brightness of the screen can be controlled through the Wisej application.

Screen Timeout

The timeout of the screen display can be controlled through the Wisej application.

Status Bar

The status bar appears on the top edge of the device's screen. It displays useful information about the time, network connectivity, and more.

Tab Bar

A tab bar is a graphical element that appears at the bottom of the user's screen. It provides an interface for quickly switching between different parts of an application.

Toolbar

The toolbar is a graphical control that features buttons, icons, and other elements to interact with the user.‌

Namespace: Wisej.Web.Ext.MobileIntegration

Assembly: Wisej.Web.Ext.MobileIntegration (2.5.0.0)

Provides methods for interacting with the device's NFC reader and writer.

public class NFC

Public Class NFC

Constructors

NFC()

Methods

ReadNFC()

Reads messages from NFC devices.

Returns: String.

Throws:

• DeviceException Occurs when the device is not able to read the data from the NFC-enabled device. See ErrorCode and Reason.

WriteNFC(message)

Writes the specified message to the NFC device.

Returns: String.

Throws:

• DeviceException Occurs when the device is not able to write the data to the NFC-enabled device. See ErrorCode and Reason.

Namespace: Wisej.Web.Ext.MobileIntegration

Assembly: Wisej.Web.Ext.MobileIntegration (2.5.0.0)

Provides functionality related to the device's camera.

public class Camera

Public Class Camera

Constructors

Camera()

Methods

ScanDocument(compressionQuality)

Detects and scans documents using the camera.

Returns: Image[]. An array Image objects containing the documents.

Throws:

• DeviceException Occurs when the device fails to scan documents. See ErrorCode and Reason.

SetFlashlight(on)

Toggles the device's flashlight.

Throws:

• DeviceException Occurs when the device fails to toggle the flashlight. See ErrorCode and Reason.

Allows the user to take a picture using the device's camera.

Returns: Image. The resulting image

Throws:

• DeviceException Occurs when the device cannot take a picture. See ErrorCode and Reason.

Allows the user to take a video using the device's camera.

Returns: String. The video's base64 encoded URL

Throws:

• DeviceException Occurs when the device cannot record a video. See ErrorCode and Reason.

Namespace: Wisej.Web.Ext.MobileIntegration

Assembly: Wisej.Web.Ext.MobileIntegration (2.5.0.0)

• Component

  • Device

Represents the user's mobile device. The Wisej application interacts with the device through this class.

public class Device : Component

Public Class Device
    Inherits Component

Properties

HasUserData

Boolean: Checks if the UserData dynamic object was created and has any value.

Info

DeviceInfo: Returns the DeviceInfo object containing information related to the user's mobile device.

Screen

DeviceScreen: Returns the DeviceScreen object containing the information related to the mobile device's screen.

Statusbar

DeviceStatusbar: Returns the DeviceStatusbar object representing the statusbar on the mobile device.

DeviceTabBar: Returns the DeviceTabBar object representing the tabBar on the mobile device.

DeviceToolbar: Returns the DeviceToolbar object representing the toolbar on the mobile device.

UserDataDictionary<String, Object>: Returns a dynamic object that can be used to store custom data in relation to the device. The data is persistent and can be accessed across different applications.

The data is serialized and deserialized using JSONConvert before and after retrieval from the device.

Boolean: Verifies that the application is running inside the mobile container.

Methods

Asks the device to authenticate the user using biometrics if available, or the device's passcode.

Throws:

• DeviceException Occurs when the device did not successfully authenticate the user. See ErrorCode and Reason.

Posts a message to the device.

Posts a message to the device and enters the modal state waiting for the response.

Returns: DeviceResponse. The response from the device.

Requests the specified permission from the device if access hasn't already been granted.

Returns: Boolean.

Throws:

• DeviceException Occurs when the permission could not be requested. See ErrorCode and Reason.

Specifies the background color of the device frame.

Triggers notification feedback on the device.

Events

DeviceEventHandler Fired when there's an update from the device's accelerometers.

DeviceEventHandler Fired when the back button is pressed on the device (Android only).

EventHandler Fired when the mobile application is sent to the background.

DeviceEventHandler Fired when the brightness of the device's screen changes.

DeviceEventHandler Fired when the device sends an event back to the application.

EventHandler Fired when the mobile application is brought to the foreground.

DeviceEventHandler Fired when there's an update from the device's gyroscope.

DeviceEventHandler Fired when there's an update from the device's magnetometer.

DeviceEventHandler Fired when a screen gets removed from the device

DeviceEventHandler Fired when the orientation of the device changes.

DeviceEventHandler Fired when a device permission value changes.

DeviceEventHandler Fired when the device receives a push notification.

DeviceEventHandler Fired when the device gets attached to a new screen

DeviceEventHandler Fired when a screen gets removed from the device

DeviceEventHandler Fired when the selected color of a ColorPicker window changes.

DeviceEventHandler Fired when the device is shaken.

DeviceEventHandler Fired when the device subscribes to remote notifications and receives a remote token

EventHandler Fired when the mobile application is terminated.

Namespace: Wisej.Web.Ext.MobileIntegration

Assembly: Wisej.Web.Ext.MobileIntegration (2.5.0.0)

Available device permission types.

public enum PermissionType : Enum

Public Enum PermissionType As [Enum]

Fields

Used By

Android

• Install Wisej Mobile from the Google Play Store.

• Add the Wisej-2-MobileIntegration NuGet package to your Wisej project.

• Register a new endpoint in the Wisej Mobile Portal.

iOS

• Install Wisej Mobile from TestFlight.

• Add the Wisej-2-MobileIntegration NuGet package to your Wisej project.

• Register a new endpoint in the Wisej Mobile Portal.

Registering an Endpoint

The Wisej Mobile Portal application uses a portal to manage multiple Wisej applications.

Add a New Application

1. Click the + button in the Wisej Mobile Android or iOS app.

2. Enter an App Name.

3. Enter the App URL.

Delete an Application

1. Select the ... beside any registered app.

2. Select Delete.

Bind App on Startup

1. Select Bind from the TabBar.

2. Enter the Application URL.

3. Select Bind App.

Example Usage

Namespace: Wisej.Web.Ext.MobileIntegration

Assembly: Wisej.Web.Ext.MobileIntegration (2.5.0.0)

Indicates the type of authentication available on the device.

Fields

Used By

Namespace: Wisej.Web.Ext.MobileIntegration

Assembly: Wisej.Web.Ext.MobileIntegration (2.5.0.0)

The mode displayed by the date picker.

Fields

Used By

Namespace: Wisej.Web.Ext.MobileIntegration

Assembly: Wisej.Web.Ext.MobileIntegration (2.5.0.0)

Provides methods for interacting with the device's sensors.

Constructors

Sensors()

Methods

StartAccelerometer()

Starts accelerometer updates.

Throws:

• Occurs when the device cannot start the accelerometer. See and .

StartGyro()

Starts gyroscope updates.

Throws:

Starts magnetometer updates.

Throws:

Stops accelerometer updates.

Stops gyroscope updates.

Stops magnetometer updates.

Namespace: Wisej.Web.Ext.MobileIntegration

Assembly: Wisej.Web.Ext.MobileIntegration (2.5.0.0)

Provides methods for displaying popups to the user.

Constructors

Popups()

Methods

Alert(title, message, options)

Displays a native alert box with the specified configuration.

Returns: . The result of the alert.

Throws:

• Occurs when the device cannot show the alert. See and .

Displays a native prompt with a set of options for the user to click.

Throws:

Shows the UIActivityViewController on iOS.

Starts a ColorPicker activity that will fire the

Shows a date picker with the specified configuration.

Throws:

Namespace: Wisej.Web.Ext.MobileIntegration

Assembly: Wisej.Web.Ext.MobileIntegration (2.5.0.0)

The different style modes available to the device.

Fields

Used By