1 of 31

API

Device.Camera

Wisej.Web.Ext.MobileIntegration.Device Camera

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.

Parameter

Type

Description

compressionQuality

The quality of the resulting images, expressed as a value from 0.0 to 1.0.

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.

Parameter

Type

Description

Specifies whether the flashlight should be on.

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.

Parameter

Type

Description

compressionQuality

The quality of the resulting image, expressed as a value from 0.0 to 1.0.

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.

Device.NFC

Wisej.Web.Ext.MobileIntegration.Device NFC

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.

Parameter

Type

Description

message

The message to write 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.

Device.PermissionType

Wisej.Web.Ext.MobileIntegration.Device PermissionType

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

Name

Description

Camera

Requests access to the device's camera.

Location

Requests access to the device's location.

Microphone

Requests access to the device's microphone.

Notifications

Requests permission to send the device notifications.

Photos

Requests access to the device's photos.

Used By

Name

Description

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

Device.PickerModes

Wisej.Web.Ext.MobileIntegration.Device PickerModes

Namespace: Wisej.Web.Ext.MobileIntegration

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

The mode displayed by the date picker.

public enum PickerModes : Enum

Public Enum PickerModes As [Enum]

Fields

Name

Description

CountDownTimer

A mode that displays hour and minute values, for example [ 1 | 53 ].

Date

A mode that displays the date in months, days of the month, and years.

DateAndTime

A mode that displays the date as unified day of the week, month, and day of the month values, plus hours, minutes, and (optionally) an AM/PM designation.

Time

A mode that displays the date in hours, minutes, and (optionally) an AM/PM designation.

Used By

Name

Description

Shows a date picker with the specified configuration.

Device.Popups

Wisej.Web.Ext.MobileIntegration.Device Popups

Namespace: Wisej.Web.Ext.MobileIntegration

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

Provides methods for displaying popups to the user.

public class Popups

Public Class Popups

Constructors

Popups()

Methods

Alert(title, message, options)

Displays a native alert box with the specified configuration.

Parameter

Type

Description

title

The title of the alert.

message

Message to display to the user.

options

The alert buttons.

Returns: String. The result of the alert.

Throws:

DeviceException Occurs when the device cannot show the alert. See ErrorCode and Reason.

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

Parameter

Type

Description

title

The title of the prompt.

message

Message to display to the user.

options

Options to show to the user. If null, it will display the default OK button.

Returns: String. The result of the prompt.

Throws:

DeviceException Occurs when the device cannot show the prompt. See ErrorCode and Reason.

Shows the UIActivityViewController on iOS.

Parameter

Type

Description

activityType

content

Starts a ColorPicker activity that will fire the

Parameter

Type

Description

selectedColor

supportsAlpha

Shows a date picker with the specified configuration.

Parameter

Type

Description

mode

The picker style.

minimumDateTime

The minimum date or time to show on the picker.

maximumDateTime

The maximum date or time to show on the picker.

startDateTime

The starting date or time for the picker.

Returns: Nullable<DateTime>. The result of the picker operation or null if an error occurred.

Throws:

DeviceException Occurs when the device cannot show the picker. See ErrorCode and Reason.

Device.Sensors

Wisej.Web.Ext.MobileIntegration.Device Sensors

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.

Device.StyleModes

Wisej.Web.Ext.MobileIntegration.Device StyleModes

Namespace: Wisej.Web.Ext.MobileIntegration

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

The different style modes available to the device.

public enum StyleModes : Enum

Public Enum StyleModes As [Enum]

Fields

Name

Description

Dark

the dark interface style.

Light

The light interface style.

Unspecified

An unspecified interface style.

Used By

Name

Description

A value indicating which mode the device is in (Dark mode, light mode, etc.).

DeviceAuthenticationType

Wisej.Web.Ext.MobileIntegration.DeviceAuthenticationType

Namespace: Wisej.Web.Ext.MobileIntegration

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

Indicates the type of authentication available on the device.

public enum DeviceAuthenticationType : Enum

Public Enum DeviceAuthenticationType As [Enum]

Fields

Name

Description

FaceID

Biometric face recognition.

None

None. The user must use the keyboard.

Passcode

The device is protected by a passcode and not enrolled in any form of biometric authentication.

TouchID

Biometric fingerprint recognition.

UnknownBiometric

The device is enrolled in a biometric form of authentication, but the type is unknown.

Used By

Name

Description

The type of authentication supported by the device.

DevicePromptOptionType

Wisej.Web.Ext.MobileIntegration.DevicePromptOptionType

Namespace: Wisej.Web.Ext.MobileIntegration

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

Determines the type of the .

Fields

Name

Description

Used By

Name

Description

Device.Popups

Wisej.Web.Ext.MobileIntegration.Device Popups

Namespace: Wisej.Web.Ext.MobileIntegration

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

Provides methods for displaying popups to the user.

public class Popups

Public Class Popups

Constructors

Popups()

Methods

Alert(title, message, options)

Displays a native alert box with the specified configuration.

Parameter

Type

Description

title

The title of the alert.

message

Message to display to the user.

options

The alert buttons.

Returns: String. The result of the alert.

Throws:

DeviceException Occurs when the device cannot show the alert. See ErrorCode and Reason.

Prompt(title, message, options)

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

Parameter

Type

Description

title

The title of the prompt.

message

Message to display to the user.

options

Options to show to the user. If null, it will display the default OK button.

Returns: String. The result of the prompt.

Throws:

DeviceException Occurs when the device cannot show the prompt. See ErrorCode and Reason.

ShowActivityView(activityType, content)

Shows the UIActivityViewController on iOS.

Parameter

Type

Description

activityType

content

ShowColorPicker(selectedColor, supportsAlpha)

Starts a ColorPicker activity that will fire the

Parameter

Type

Description

selectedColor

supportsAlpha

ShowDatePicker(mode, minimumDateTime, maximumDateTime, startDateTime)

Shows a date picker with the specified configuration.

Parameter

Type

Description

mode

The picker style.

minimumDateTime

The minimum date or time to show on the picker.

maximumDateTime

The maximum date or time to show on the picker.

startDateTime

The starting date or time for the picker.

Returns: Nullable<DateTime>. The result of the picker operation or null if an error occurred.

Throws:

DeviceException Occurs when the device cannot show the picker. See ErrorCode and Reason.

API

Device.Camera

Constructors

Camera()

Methods

ScanDocument(compressionQuality)

SetFlashlight(on)

Device.NFC

Constructors

NFC()

Methods

ReadNFC()

WriteNFC(message)

Device.PermissionType

Fields

Used By

Device.PickerModes

Fields

Used By

Device.Popups

Constructors

Popups()

Methods

Alert(title, message, options)

Device.Sensors

Constructors

Sensors()

Methods

StartAccelerometer()

StartGyro()

Device.StyleModes

Fields

Used By

DeviceAuthenticationType

Fields

Used By

DevicePromptOptionType

Fields

Used By

Device.PickerModes

Fields

Used By

Device.Camera

Constructors

Camera()

Methods

ScanDocument(compressionQuality)

SetFlashlight(on)

TakePicture(compressionQuality)

TakeVideo()

TakePicture(compressionQuality)

TakeVideo()

Device.PermissionType

Fields

Used By

DeviceAuthenticationType

Fields

Used By

Device.Popups

Constructors

Popups()

Methods

Alert(title, message, options)

Prompt(title, message, options)

ShowActivityView(activityType, content)

ShowColorPicker(selectedColor, supportsAlpha)

ShowDatePicker(mode, minimumDateTime, maximumDateTime, startDateTime)

Device.NFC

Constructors

NFC()

Methods

ReadNFC()

WriteNFC(message)

Device.StyleModes

Fields

Used By

Device.Sensors

Constructors

Sensors()

Methods