Xamarin.Essentials Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Xamarin.Essentials offers a cross-platform API for platform specific features.
Classes
Accelerometer |
Accelerometer data of the acceleration of the device in three dimensional space. |
AccelerometerChangedEventArgs |
Event arguments containing the current reading. |
ActivityStateChangedEventArgs |
Event argments when an Android Activity's state changes. |
AppAction | |
AppActionEventArgs | |
AppActions | |
AppInfo |
Represents information about the application. |
AppleSignInAuthenticator |
Native Apple Sign In authentication API. |
AppleSignInAuthenticator.Options |
Options for Native Apple Sign In |
Barometer |
Monitor changes to the atmospheric pressure. |
BarometerChangedEventArgs |
The current pressure information from the change event. |
Battery |
Methods and properties for battery and charging information of the device. |
BatteryInfoChangedEventArgs |
Battery changed information. |
Browser |
Provides a way to display a web page inside an app. |
BrowserLaunchOptions |
Optional setting to open the browser with. |
Clipboard |
Provides a way to work with text on the device clipboard. |
ColorConverters |
Contains several helper methods to convert System.Drawing.Color |
ColorExtensions |
Extension methods for System.Drawing.Color |
Compass |
Monitor changes to the orientation of the user's device. |
CompassChangedEventArgs |
Event arguments when compass reading changes. |
Connectivity |
Connectivity and networking helpers. |
ConnectivityChangedEventArgs |
The current connectivity information from the change event. |
Contact |
This type contains information about a particular contact. |
ContactEmail |
This type contains information about a particular email address. |
ContactPhone |
This type contains information about a particular phone number. |
Contacts |
API class for working with contacts on the device. |
DeviceDisplay |
Represents information about the device screen. |
DeviceInfo |
Represents information about the device. |
DisplayInfoChangedEventArgs |
Main display information event arguments. |
Provides an easy way to allow the user to send emails. |
|
EmailAttachment |
Email file attachment. |
EmailMessage |
Represents a single email message. |
EnergySaverStatusChangedEventArgs |
Event arguments when the energy saver status changes. |
ExperimentalFeatures |
Enables experimental features in Xamarin.Essentials |
FeatureNotEnabledException |
An exception thrown when a feature on the device is not enabled. |
FeatureNotSupportedException |
Exception that occurs when an attempt is made to use a feature on a platform that does not support it. |
FileBase |
A representation of a file and its content type. |
FilePicker |
Lets the user pick a file from the device's storage. |
FilePickerFileType | |
FileProvider |
Android FileProvider implementation for creating Content URIs to share files with other applications. |
FileResult | |
FileSystem |
Provides an easy way to access the locations for device folders. |
Flashlight |
Turn the Flashlight / Torch / Lamp On and Off. |
Geocoding |
Easily convert between geographic coordinated and place names. |
Geolocation |
Provides a way to get the current location of the device. |
GeolocationRequest |
Represents the criteria for a location request. |
Gyroscope |
Gyroscope data of the rotation around the device's three primary axis. |
GyroscopeChangedEventArgs |
Event arguments containing the current reading. |
HapticFeedback |
Provides methods to control HapticFeedback responses |
Launcher |
Launches an application specified by the passed uri. |
Locale |
Represents a specific geographical, political, or cultural region. |
Location |
The latitude, longitude, altitude and time information reported by the device. |
LocationExtensions |
Location Extensions |
Magnetometer |
Detect device's orentation relative to Earth's magnetic field in microteslas (µ). |
MagnetometerChangedEventArgs |
Event arguments containing the current reading. |
MainThread |
Main Thread helpers. |
Map |
Map helpers to open a route to specified places via default platforms maps implementation. |
MapLaunchOptions |
Launch options for opening a map. |
MediaPicker | |
MediaPickerOptions | |
NotImplementedInReferenceAssemblyException |
Exception that occurs when executed from a reference assembly. This usually means that the NuGet was not installed into the app project. |
OpenFileRequest |
Standard request for opening a file to another application. |
OrientationSensor |
Device orientation (quaternion) relative to magnetic fields. |
OrientationSensorChangedEventArgs |
Orientation event args when reading changes. |
PermissionException |
Exception that occures when calling an API that requires a specific permission. |
Permissions |
Access to checking and requesting application permissions. |
Permissions.BasePermission |
Base permission, used internally. |
Permissions.BasePlatformPermission |
Base platform permission, used internally. |
Permissions.Battery |
Permission for battery |
Permissions.CalendarRead |
Permission to read the calendar |
Permissions.CalendarWrite |
Permission to write to the calendar. |
Permissions.Camera |
Permission to access the camera. |
Permissions.ContactsRead |
Permission to read contacts. |
Permissions.ContactsWrite |
Permission to write contacts |
Permissions.EventPermissions |
Permission to access events. |
Permissions.Flashlight |
Permissiont to access the flashlight. |
Permissions.LaunchApp |
Permissions to launch an app. |
Permissions.LocationAlways |
Permission for geolocation always. |
Permissions.LocationWhenInUse |
Permission for geolocation when the app is in use. |
Permissions.Maps |
Permission to access maps. |
Permissions.Media |
Permission to access media on device. |
Permissions.Microphone |
Permission to access the microphone. |
Permissions.NetworkState |
Permission to access the network state. |
Permissions.Phone |
Permission to access the phone. |
Permissions.Photos |
Permission to access the photo album. |
Permissions.Reminders |
Permission to access reminders. |
Permissions.Sensors |
Permission to access device sensors. |
Permissions.Sms |
Permission to access Sms capabilities on device. |
Permissions.Speech |
Permission to access speech capabilities on device. |
Permissions.StorageRead |
Permission to read storage. |
Permissions.StorageWrite |
Permission to write to storage. |
Permissions.Vibrate |
Permission to vibrate device. |
PhoneDialer |
Open the platform phone dialer to place a call. |
PickOptions |
File picking options. |
Placemark |
User-friendly description of a geographic coordinate. This contains information such as the name of the place, its address, and other information. |
PlacemarkExtensions |
Extensions for the placemark. |
Platform |
Platform specific helpers. |
Platform.Intent | |
PointExtensions |
Extension methods for Point. |
Preferences |
A class to interact with the preferences/settings of the native platform. |
ReadOnlyFile |
A representation of a file and its content type. |
RectangleExtensions |
Extension methods for Rectangle. |
Screenshot |
Take a screenshot depicting the current View. |
ScreenshotResult | |
SecureStorage |
Provides simple secure storage for key/value pairs. |
Share |
Share data such as text and uris to other applications. |
ShareFile |
A file to be shared. |
ShareFileRequest |
Standard request for sharing a file to another application. |
ShareMultipleFilesRequest |
Standard request for sharing a multiple files to another application. |
ShareRequestBase | |
ShareTextRequest |
Standard request for sharing text to other applications. |
SizeExtensions |
Extension methods for Size. |
Sms |
Provides an easy way to allow the user to send SMS messages. |
SmsMessage |
Represents a single SMS message. |
SpeechOptions |
Text-to-speech options. |
TextToSpeech |
Speak text to Speech |
UnitConverters |
Built in unit converters |
VersionTracking |
Provides an easy way to track an app's version on a device. |
Vibration |
Provides an easy way to make the device vibrate. |
WebAuthenticator |
A web navigation API intended to be used for Authentication with external web services such as OAuth. |
WebAuthenticatorCallbackActivity |
The activity meant to be subclassed and implemented to receive callbacks on Android. |
WebAuthenticatorResult |
Web Authenticator Result parsed from the callback Url. |
Structs
AccelerometerData |
Data representing the devies' three accelerometers. |
BarometerData |
Contains the pressure measured by the user's device. |
CompassData |
Contains the orientation of the user's device. |
DeviceIdiom |
The idiom (form factor) of the device. |
DevicePlatform |
The device platform that the application is running on. |
DisplayInfo |
Represents information about the screen. |
GyroscopeData |
Gyroscope information. |
MagnetometerData |
Data for magnetometer changes. |
OrientationSensorData |
Sensor data for orientation. |
Enums
ActivityState |
A state of an Android Activity. |
AltitudeReferenceSystem |
Indicates the altitude reference system to be used in defining a location. |
AppTheme |
Application Theme Type |
BatteryPowerSource |
How the device and battery are currently being powered or charged. |
BatteryState |
The current state of the battery and if it is being charged or full. |
BrowserLaunchFlags |
Additional flags that can be set to control how the browser opens. |
BrowserLaunchMode |
Launch type of the browser. |
BrowserTitleMode |
Mode for the title. |
ConnectionProfile |
Describes the type of connection the device is using. |
DeviceType |
Various types of devices. |
DisplayOrientation |
Display Orientation |
DisplayRotation |
Display rotation. |
DistanceUnits |
Distance Unit for use in conversion. |
EmailBodyFormat |
Represents various types of email body formats. |
EnergySaverStatus |
Status of energy saver on the device. |
FileProviderLocation |
Location to save temporary files to for sharing. |
GeolocationAccuracy |
Represents levels of accuracy when determining location. |
HapticFeedbackType |
Enumerates the possible types of HapticFeedback response |
NavigationMode |
Represents various modes of navigation. |
NetworkAccess |
Various states of the connection to the internet. |
PermissionStatus |
Status of the permission. |
ScreenshotFormat |
The format to read screenshot images. |
SensorSpeed |
Sensor speed to monitor for changes. |