Device

Namespace: Wisej.Hybrid

Assembly: Wisej.Hybrid

• Component
  • Device

The "gateway" into the Hybrid client that provides access to native device properties, methods, and events.

C#

public class Device : Component

VB.NET

Public Class Device
    Inherits Component

Properties

AppActions

DeviceAppActions: Manages application actions, such as shortcuts to specific parts of the application. This class provides methods to retrieve and set app actions, which can be used for quick access.

Use of this class requires additional setup. See App Actions for more details.

AppInfo

DeviceAppInfo: Provides methods to interact with the application info.

AppLinks

DeviceAppLinks: Provides methods to register and deregister application deep links.

Authenticator

DeviceAuthenticator: A web navigation API intended to be used for Authentication with external web services such as OAuth.

This API helps with navigating to a start URL and waiting for a callback URL to the app. Your app must be registered to handle the callback scheme you provide in the call to authenticate.

Background

DeviceBackground: Provides properties to interact with the device's background.

Border

DeviceBorder: Provides methods to interact with the device's border.

BottomBar

DeviceBottomBar: Provides properties to interact with the device's bottom bar.

Browser

DeviceBrowser: Provides methods to open the device's embedded or external web browser.

Clipboard

DeviceClipboard: Provides methods for interacting with the client device's clipboard.

Contacts

DeviceContacts: Provides methods to access the device's contacts.

Display

DeviceDisplay: Provides properties and events to interact with the device's display.

Email

DeviceEmail: Provides methods to access the device's email client.

FileSystem

DeviceFileSystem: Provides methods to interact with the device's file system.

Flashlight

DeviceFlashlight: Provides methods to interact with the device's flashlight.

Flyout

DeviceFlyout: Provides properties, methods, and events to interact with the Hybrid client's Flyout.

Geolocation

DeviceGeolocation: Provides methods to fetch the user's location.

HapticFeedback

DeviceHapticFeedback: Provides methods to trigger haptic feedback on the client device.

Info

DeviceInfo: Provides information about the hybrid client.

Launcher

DeviceLauncher: Provides methods to launch other apps.

Lifecycle

DeviceLifecycle: Provides events related to the device lifecycle.

LocalNotification

DeviceLocalNotification: Provides methods to schedule and handle local notifications on the device.

Logs

DeviceLogs: Provides an event to log device events.

Map

DeviceMap: The Map API enables an application to open the installed map application to a specific location or placemark.

Media

DeviceMedia: Provides properties and methods to interact with device media.

MenuBar

DeviceMenuBar: Provides methods to interact with the device's menu bar.

Navigation

DeviceNavigation: Provides methods for handling navigation and page transitions within the app.

Permissions

DevicePermissions: Provides methods to interact with device permissions.

Popups

DevicePopups: Provides methods to show popups.

Preferences

DevicePreferences: Manages device preferences, allowing retrieval and storage of user preferences.

Resources

DeviceResources: Provides methods for accessing resources embedded within the Hybrid client application.

Screen

DeviceScreen: Provides methods for interacting with the device's screen, including taking screenshots and screen recording.

SecureStorage

DeviceSecureStorage: Provides secure storage functionality for sensitive information on the device. This class allows for the storing, retrieving, and deleting of secure information.

This class requires special setup. See: https://learn.microsoft.com/en-us/dotnet/maui/platform-integration/storage/secure-storage for details.

Sensors

DeviceSensors: Provides integrations to interact with device sensors.

Sharing

DeviceSharing: Provides methods for sharing data on the client device.

Sms

DeviceSms: Provides methods to compose a SMS.

Speech

DeviceSpeech: Provides methods to interact with the device's speech module.

StatusBar

DeviceStatusBar: Provides properties to interact with the device's status bar.

TabBar

DeviceTabBar: Provides acceess to the client device's tab bar.

Theme

DeviceTheme: Provides methods to interact with the Hybrid client app's theme.

TitleBar

DeviceTitleBar: Provides information about the application's title bar.

Toolbar

DeviceToolbar: Provides access to the client device's toolbar.

Valid

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

Vibration

DeviceVibration: Provides methods to vibrate the client device.

Windows

DeviceWindows: Provides methods to interact with device windows.

Methods

PostMessage(handler, action, args)

Posts a message to the device.

Parameter	Type	Description
handler	String	The handler to post to the device, i.e., "tabBar".
action	String	The action to perform on the handler.
args	Object[]	The arguments associated with the action.

PostMessageAsync(handler, action, args)

Posts an asynchronous message to the hybrid client.

Parameter	Type	Description
handler	String	The handler.
action	String	The action to perform on the handler.
args	Object[]	The action arguments.

Returns: Task<Object>. A task representing the result of the operation.

PostModalMessage(handler, action, args)

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

Parameter	Type	Description
handler	String	The handler to post to the device, i.e., "tabBar".
action	String	The action to perform on the handler.
args	Object[]	The arguments associated with the action.

Returns: DeviceResponse. The response from the device.

RegisterEventListener(handler, callback)

Registers a client device event listener.

Parameter	Type	Description
handler	String	The handler identifier.
callback	Action<DeviceEvent>	The callback to execute.

RemoveEventListener(handler, callback)

Removes an event listener, if it exists.

Parameter	Type	Description
handler	String	The handler identifier.
callback	Action<DeviceEvent>	The event callback to detach.

Use<T>()

Gets the given member or extension.

Parameter	Type	Description
T		The type of the member or extension.

Returns: T. The member or extension.