Xamarin.Essentials
Accelerometer data of the acceleration of the device in three dimensional space.
Gets if accelerometer is being monitored.
If monitoring.
Event triggered when reading of sensor changes.
Event triggered when a shake has been detected on the device.
Speed to monitor the sensor.
Start monitoring for changes to accelerometer.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
Stop monitoring for changes to accelerometer.
Event arguments containing the current reading.
The accelerometer data reading.
Public constructor that takes in a reading for event arguments.
To be added.
The current values of accelerometer.
The reading.
Data representing the devies' three accelerometers.
X data
Y data
Z data
Public constructor for accelerometer data.
To be added.
X data
Y data
X data
Public constructor for accelerometer data.
To be added.
Gets the acceleration vector in G's (gravitational force).
Object to compare
If equal to another object
If equal
Other AccelerometerData to compare with.
Compares the underlying Vector3 instances.
True if they are equal, otherwise false.
Get the hash code for object.
The hash code
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
To be added.
To be added.
To be added.
A state of an Android Activity.
An Activity is in the OnCreate state
An Activity is in the OnDestroyed state
An Activity is in the OnPaused state
An Activity is in the OnResumed state
An Activity is in the SaveInstanceState state
An Activity is in the OnStarted state
An Activity is in the OnStopped state
Event argments when an Android Activity's state changes.
Gets the Activity of which the state changed.
The Activity for the event.
The state of the Activity.
The state of the Activity for the event.
Indicates the altitude reference system to be used in defining a location.
This enum is a copy of Windows.Devices.Geolocation.AltitudeReferenceSystem.
The altitude reference system is based on an ellipsoid (usually WGS84), which is a mathematical approximation of the shape of the Earth.
The altitude reference system is based on the distance above sea level (parametrized by a so-called Geoid).
The altitude reference system is based on the distance above the tallest surface structures, such as buildings, trees, roads, etc., above terrain or ground level.
The altitude reference system is based on distance above terrain or ground level.
The altitude reference system was not specified.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Represents information about the application.
Gets the application build number.
The application build number.
Gets the application name.
The application name.
Gets the application package name or identifier.
The package name or identifier.
On Android and iOS, this is the application package name. On UWP, this is the application GUID.
Gets the detected Theme of the system or application.
The Theme.
For platforms or platform versions which aren't supported, Unspecified is returned.
Open the settings menu or page for the application.
Gets the application version.
The application version.
Gets the application version.
The application version.
Native Apple Sign In authentication API.
This API is only supported on iOS 13.0+ and should not be called on other devices at runtime.
Additional Sign In options.
Performs a native Apple Sign In authentication request.
Options for Native Apple Sign In
To be added.
Include email scope.
Include full name scope.
Application Theme Type
Dark Theme
Light Theme
Default, Unknown or Unspecified Theme
Monitor changes to the atmospheric pressure.
Gets if barometer is actively being monitored.
If barometer is being monitored.
Event triggered when barometer reading changes.
The speed to listen for changes.
Start monitoring for changes to the barometer.
Will throw FeatureNotSupportedException if not supported on device.
Stop monitoring for changes to the barometer.
The current pressure information from the change event.
The current reading
Public constructor for barometer changed event args.
To be added.
Gets the current barometer pressure data
Pressure in hPA
Contains the pressure measured by the user's device.
The current pressure
Public constructor for barometer data.
To be added.
Object to compare
If equal to another object
If equal
Other object to compare
If equal to another object
If equal
Get has code for object.
The hash code.
Left to compare
Right to compare
If equal to another object
If equal
Left to comapre
Right to comapre
If not equal to another object
If not equal
Gets the current pressure in hectopascals.
To be added.
Outputs the data as a string.
To be added.
Methods and properties for battery and charging information of the device.
Platform specific remarks:
- Android: Battery_Stats permission must be set in manifest.
- iOS: Simulator will not return battery information, must be run on device
- UWP: None
Event trigger when battery properties have changed.
Gets the current charge level of the device from 0.0 to 1.0.
Level of charge. Returns -1 if no battery exists.
Gets the current energy saver status of the device.
The current status of energy saver mode.
Event that is triggered when energy saver status changes.
Gets the current power source for the device.
Power source, or uknown.
Gets the charging state of the device if it can be determined.
Battery state, or unknown.
Battery changed information.
Returns the current information of the battery.
The current level of the batter.
The state of the battery
The source of the battery
The public constructor.
To be added.
Gets the current charge level of the device from 0.0 to 1.0.
Level of charge.
Gets the current power source for the device.
Power source, or unknown
Gets the charging state of the device if it can be determined.
Battery state, or unknown.
Outputs the data as a string.
To be added.
How the device and battery are currently being powered or charged.
Power source is an AC Charger.
Power source is the battery and not being charge.
Power source can not be determined.
Power source is a USB port.
Power source is wireless.
The current state of the battery and if it is being charged or full.
Battery is acively being charged by a power source.
Battery is not plugged in and discharging.
Battery is full.
Battery is not charging or discharging, but in an inbetween state.
Battery does not exist on the device.
Battery state could not be determined.
Provides a way to display a web page inside an app.
Uri to launch.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
How to launch the browser.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
Launch options for the browser.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
How to launch the browser.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Uri to launch.
Launch options for the browser.
Open the browser to specified uri.
Completed task when browser is launched, but not necessarily closed. Result indicates if launching was successful or not.
Additional flags that can be set to control how the browser opens.
On Android to launch the new activity adjacent to the current one if available.
No additional flags. This is the default.
On iOS to launch the browser as a form sheet with system preferred browser where supported.
On iOS to launch the browser as a page sheet with system preferred browser where supported.
Launch type of the browser.
Recommended to use the SystemBrowser as it is the default and falls back to UriLauncher.
Use the default external launcher to open the browser outside of the app.
Launch the optimized system browser and stay inside of your application. (Chrome Custom Tabs and SFSafariViewController).
Optional setting to open the browser with.
These settings do not apply to all operation systems. Check documentation for more information.
Default constructor.
Additional launch flags that may or may not take effect based on the device and launch mode.
To be added.
To be added.
Launch type of the browser.
The launch type.
Preferred color of the controls on the browser.
Gets the color for controls.
Preferred color of the background toolbar.
Gets the toolbar color.
Preferred mode for the title display.
Gets the title display mode.
Mode for the title.
Uses the system default showing it.
Hide the title.
Show the title.
Provides a way to work with text on the device clipboard.
Fires when the clipboard content changes.
Returns any text that is on the clipboard.
Returns text that is on the clipboard, or null if there is none.
Gets a value indicating whether there is any text on the clipboard.
The text to put on the clipboard.
Sets the contents of the clipboard to be the specified text.
Returns text that is on the clipboard, or null if there is none.
This method returns immediately and does not guarentee that the text is on the clipboard by the time this method returns
Contains several helper methods to convert System.Drawing.Color
A string value similar to the syntax used in HTML, eg "00FF00". Alpha can optionally be specified as the first pair of the characters ("CC00FF00").
Creates a new Color from a Hex string.
A color from the Hex string.
The hue of the color from 0-360.
The saturation of the color from 0-100.
The luminosity of the color from 0-100.
Creates a new Color from hue, saturation, and lightness.
A new color from the Hsla.
The hue of the color from 0-360.
The saturation of the color from 0-100.
The luminosity of the color from 0-100.
The alpha of the color from 0-255.
Creates a new Color from hue, saturation, luminosity, and alpha.
A new color from the Hsla.
A single value representing argb.
Creates a new Color from an UInt.
A new color from the Uint
Extension methods for System.Drawing.Color
The color to add luminosity to.
The delta to add to the current luminosity.
Adds luminosity to the existing color
The new color.
The Hue value in double.
The Saturation value in double.
The Value value in double.
The Alpha value in double.
Convert HSVa color into System.Drawing.Color.
System.Drawing.Color.
A color to obtain the complement for.
Returns a new color that is on the opposite side of the color wheel from the original.
A color that is the complement of the value passed in.
The current color to manipulate.
The percentage from 0-1f
Multiplies the current alpha by a percentage (0-1f)
The new color.
The current color to manipulate.
Convert a System.Drawing.Color struct into HSV Color.
A tuple of doubles with the values of Hue, Saturation and Value, respectively.
The color to convert
Converts the current color to an interger
The color as an integer
To be added.
The color to use as a base.
Converts the color to the system specific color.
The system color.
To be added.
To be added.
To be added.
To be added.
The color to use as a base.
Converts the color to the system specific color.
The system color.
The color to use as a base.
Converts the color to the system specific color.
The system color.
The color to use as a base.
Converts the color to a UInt representation.
The UInt representation.
The color to use as a base.
The alpha to set 0-255.
Creates a new color based on this color, but with a new alpha (0-255).
The new color.
The color to use as a base.
The hue to set 0-360.
Creates a new color based on this color, but with a new hue (0-360).
The new color.
The color to use as a base.
The luminosity to set 0-100.
Creates a new color based on this color, but with a new luminosity (0-100).
The new color.
The color to use as a base.
The saturation to set 0-100.
Creates a new color based on this color, but with a new saturation (0-100).
The new color.
Monitor changes to the orientation of the user's device.
Gets if compass is actively being monitored.
If compass is being monitored.
Event triggered when compass reading changes.
Determines if the calibration screen should be displayed.
Gets or sets if this should be displayed when started.
Only available on iOS
The speed to monitor for changes.
Start monitoring for changes to the compass.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
The speed to monitor for changes.
Whether or not to apply a moving average filter (only used on Android).
Start monitoring for changes to the compass.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
Stop monitoring for changes to the compass.
Event arguments when compass reading changes.
The current compass reading.
Public constructor
To be added.
Gets the current reading.
The reading.
Contains the orientation of the user's device.
A reading of compass data for heading magnetic north.
Public constructor.
To be added.
Object to compare
If equal to another object
If equal
Other AccelerometerData to compare with.
Compares the underlying doubles.
True if they are equal, otherwise false.
Get the hash code for object.
The hash code
The heading (measured in degrees) relative to magnetic north.
The magnetic north heading.
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
Current string representation of the data.
To be added.
Describes the type of connection the device is using.
The bluetooth data connection.
The mobile/cellular data connection.
The ethernet data connection.
Other unknown type of connection.
The WiFi data connection.
Connectivity and networking helpers.
Gets the active connectivity types for the device.
List of all connection profiles.
Can throw PermissionException on Android if ACCESS_NETWORK_STATE is not set in manifest.
Event that is triggered when a network access or profile has changed.
Can throw PermissionException on Android if ACCESS_NETWORK_STATE is not set in manifest.
Gets the current state of network access. Does not guarantee full access to the internet.
The current network access state.
Can throw PermissionException on Android if ACCESS_NETWORK_STATE is not set in manifest.
The current connectivity information from the change event.
The current access of the network
The connection profiles of the events changing
Public constructor
Gets the active connectivity types for the device.
List of all connection profiles.
Gets the current state of network access. Does not guarantee full access to the internet.
The current network access state.
The string representation of the event.
This type contains information about a particular contact.
Constructs a new instance of .
The identifier of the contact.
The prefix of the contact.
The given name or first name of the contact.
The middle name(s) of the contact.
The family name or last name of the contact.
The suffix of the contact.
A collection of phone numbers for the contact.
A collection of email addresses for the contact.
The display name of the contact.
Constructs a new instance of using the various parameters.
Gets or sets the display name of the contact.
Gets or sets a collection of email addresses of the contact.
Gets or sets the family name or last name of the contact.
Gets or sets the given name or first name of the contact.
Gets or sets the identifier of the contact.
Gets or sets the middle name(s) of the contact.
Gets or sets the name prefix of the contact.
Gets or sets the name suffix of the contact.
Gets or sets a collection of phone numbers of the contact.
This type contains information about a particular email address.
Constructs a new instance of .
The email address.
Constructs a new instance of using the various parameters.
Gets or sets the email address.
This type contains information about a particular phone number.
Constructs a new instance of .
The phone number.
Constructs a new instance of using the various parameters.
Gets or sets the phone number.
API class for working with contacts on the device.
A token for cancelling the operation
Gets a collection of all the contacts on the device.
Returns a collection of contacts on the device.
Starts file picker for selecting a single contact.
Returns a single contact, or null if the user cancelled the operation.
Represents information about the device screen.
Gets or sets if the screen shold be kept on.
If the screen keep on is set.
Gets the main screens display info.
The main screen display info.
Event that is triggered when the main display info changes.
The idiom (form factor) of the device.
The idiom name of the device
Creates a new device idiom.
Gets the desktop idiom.
To be added.
The object ot compare.
Checks the equality of the idiom.
If the values are equal
To be added.
The object ot compare.
Checks the equality of the idiom.
If the values are equal
To be added.
Gets the hash code for the idom.
The hashc ode
To be added.
The left idiom to compare.
The right idiom to compare.
Checks the equality of the idiom.
If they are equal
To be added.
The left idiom to compare.
The right idiom to compare.
Checks the equality of the idiom.
If they are inequal
To be added.
Gets the phone idiom.
The phone idiom
To be added.
Gets the tablet idiom.
The tablet idiom
To be added.
String representation of the idiom.
String representation of the idiom.
To be added.
Gets the TV idiom.
The TV idiom
To be added.
Gets the unknown idiom.
An unknown idiom.
To be added.
Gets the watch idiom.
The watch idiom
To be added.
Represents information about the device.
Gets the type of device the application is running on.
The device type.
Gets the idiom of the device.
The idiom.
Gets the manufacturer of the device.
Device manufacturer.
Gets the model of the device.
Device model.
Gets the name of the device.
The name of the device (often specified by the user).
Gets the platform or operating system of the device.
The platform of device.
Gets the version of the operating system.
The device operating system.
Gets the version of the operating system.
The version of the operating system.
The device platform that the application is running on.
Gets the Android platform.
The Android platform
To be added.
The device platform.
Creates a new Device Platform.
The device platform
To be added.
The object compare
Checks the equality of the platform.
If they are equal
To be added.
The platform to compare
Checks the equality of the platform.
If they are equal
To be added.
Gets the hash code of the platform.
The hash code of the platform.
To be added.
Gets the iOS platform.
The iOS Platform
To be added.
To be added.
To be added.
To be added.
The left side to compare.
The right side to compare
Checks the equality of the platform.
If they are equal
To be added.
The left side to compare.
The right side to compare
Checks the equality of the platform.
If they are inequal
To be added.
Gets the Tizen platform
The Tizen platform
To be added.
The string representation of the platform.
The string representation of the platform.
To be added.
Gets the tvOS platform
The tvOS platform
To be added.
Gets the unknown platform.
An unknown platform
To be added.
Gets the UWP platform.
The UWP platform
To be added.
Gets the watchOS platform
The watchOS platform.
To be added.
Various types of devices.
The device is a physical device, such as an iPhone, Android tablet or Windows desktop.
An unknown device type.
The device is virtual, such as the iOS simulators, Android emulators or Windows emulators.
Represents information about the screen.
The width of the display
The height of the display
The screen density
The current orientation
The rotation of the device.
Main constructor for Display Information
To be added.
The width of the display
The height of the display
The screen density
The current orientation
The rotation of the device.
The refresh rate of the display.
Main constructor for Display Information
To be added.
Gets a value representing the screen density.
The screen density.
The density is the scaling or a factor that can be used to convert between physical pixels and scaled pixels. For example, on high resolution displays, the physical number of pixels increases, but the scaled pixels remain the same.
In a practical example for iOS, the Retina display will have a density of 2.0 or 3.0, but the units used to lay out a view does not change much. A view with a UI width of 100 may be 100 physical pixels (density = 1) on a non-Retina device, but be 200 physical pixels (density = 2) on a Retina device.
On Windows or UWP, the density works similarly, and may often relate to the scale used in the display. On some monitors, the scale is set to 100% (density = 1), but on other high resolution monitors, the scale may be set to 200% (density = 2) or even 250% (density = 2.5).
Object to compare.
If equal to another object.
If equal.
The other display info to compare.
If equal to another object.
If equal.
Gets the hash code for object.
The hash code.
Gets the height of the screen for the current orientation.
The height in pixels.
Left to compare.
Right to compare.
If equal to another object.
If equal
Left to compare
Right to compare
If not equal to another object.
If not equal
Gets the orientation of the device.
The orientation.
Gets the refresh rate of the display.
The refresh rate in Hz.
Gets the rotation from the designated orientation.
The rotation
String representation of information.
String information about display info.
Gets the width of the scrreen for the current orientation.
The width in pixels.
Main display information event arguments.
The display info for the event
Main constructor for event args.
To be added.
Gets the current display info for the main display.
The current display info.
To be added.
Display Orientation
Display is in landscape.
Display is in portrait.
Unknown display orientation.
Display rotation.
Rotated 0 degrees.
Rotated 180 degrees.
Rotated 270 degrees.
Rotated 90 degrees.
Unknown display rotation.
Distance Unit for use in conversion.
Kilometers
Miles
Provides an easy way to allow the user to send emails.
Opens the default email client to allow the user to send the message.
The email message.
Opens the default email client to allow the user to send the message.
The email subject.
The email body.
The email recipients.
Opens the default email client to allow the user to send the message with the provided subject, body and recipients.
Email file attachment.
Full path and filename to file.
Email attachment from filename.
Existing file.
Email attachment from existing file.
Full path and filename to file.
Content type (MIME type) of the file (eg: `image/png`).
Explicit content type (MIME type) of file.
Represents various types of email body formats.
The email message body is HTML (not supported on UWP).
The email message body is plain text.
Represents a single email message.
Creates a new instance of EmailMessage.
The email subject.
The email body.
The email's recipients.
Creates a new instance of EmailMessage with the specified subject, body and recipients.
Gets or sets a list of file attachments.
Gets or sets the email's BCC recipients.
Gets or sets the email's body.
Gets or sets a value indicating whether the message is in plain text or HTML (not supported on UWP).
Gets or sets the email's CC recipients.
Gets or sets the email's subject.
Gets or sets the email's recipients.
Status of energy saver on the device.
Energy save is off
Energy saver is on
Status of energy saver is unknown.
Event arguments when the energy saver status changes.
To be added.
The current status of the event.
Public constructor for event arguments
To be added.
Gets the current status of energy saver mode
The current statu of the energy saver mode.
To be added.
A string representation of the event arguments.
A string representation of the event arguments.
To be added.
Enables experimental features in Xamarin.Essentials
Obsolete as of version 1.3.0 and no longer required to use the feature. Experimental feature for email attachments.
List of features to enable.
Enable experimental features for Xamarin.Essentials.
To be added.
To be added.
Obsolete as of version 1.3.0 and no longer required to use the feature. Experimental feature for requesting a file to be opened.
Obsolete as of version 1.3.0 and no longer required to use the feature. Experimental feature for share a file with other applications.
An exception thrown when a feature on the device is not enabled.
To be added.
Public constructor
To be added.
Message for the developer to use when debugging.
Public constructor
To be added.
Message for the developer to use when debugging.
Inner exception related.
Public constructor
To be added.
Exception that occurs when an attempt is made to use a feature on a platform that does not support it.
Creates a new instance of FeatureNotSupportedException.
The exception message.
Creates a new instance of FeatureNotSupportedException with the specified message.
The exception message.
The inner exception.
Creates a new instance of FeatureNotSupportedException with the specified message and inner exception.
A representation of a file and its content type.
An existing FileBase instance to use.
FileBase from an existing instance.
Gets or sets the file's content type as a MIME type (eg: `image/png`).
To be added.
To be added.
To be added.
Gets the full path and filename.
To be added.
To be added.
To be added.
Lets the user pick a file from the device's storage.
File picker options to use; may be null
Starts file picker for selecting a single file.
File picking result object, or null when picking was cancelled by the user.
File types can be specified in order to limit files that can be selected, using a
PickOptions object. Note that this method may re-throw platform specific exceptions that
occured during file picking. When calling PickAsync() again while showing a file
picker, the Task object that was returned from the first call is cancelled. Be sure to
also handle the TaskCanceledException in this case.
File picker options to use; may be null
Starts file picker for selecting a single file.
File picking result object, or null when picking was cancelled by the user.
File types can be specified in order to limit files that can be selected, using a
PickOptions object. Note that this method may re-throw platform specific exceptions that
occured during file picking. When calling PickMultipleAsync() again while showing a file
picker, the Task object that was returned from the first call is cancelled. Be sure to
also handle the TaskCanceledException in this case.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Image file types.
JPEG file type (*.jpeg, *.jpg).
PDF file type (*.pdf).
PNG file type (*.png).
To be added.
To be added.
To be added.
Video file types.
Android FileProvider implementation for creating Content URIs to share files with other applications.
Default constructor.
Gets or sets the temporary location for file sharing.
The default is to prefer external and fallback to internal.
Location to save temporary files to for sharing.
External storage or cache only.
Internal cache only,
Prefer external and fall back to internal if unavailable.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Provides an easy way to access the locations for device folders.
Gets the location where app data can be stored.
The location where app data can be stored.
This location usually is not visible to the user, and is backed up.
Gets the location where temporary data can be stored.
The location where temporary data can be stored.
This location usually is not visible to the user, is not backed up, and may be cleared at any time.
the name of the file to load from the app package.
Opens a stream to a file contained within the app package.
Returns a stream to the file.
Turn the Flashlight / Torch / Lamp On and Off.
Turns the Flashlight Off.
Turns the Flashlight On.
Easily convert between geographic coordinated and place names.
Address to retrieve the lcoation for.
Retrieve location for a given address.
List of locations that best match the address or null if none found.
Location to find placemarks for.
Retrieve placemarks for a given location.
List of placemarks or null if no placemarks are found.
Latitude of the location.
Longitude of the location.
Retrieve location for a given address.
List of placemarks or null if no placemarks are found.
Provides a way to get the current location of the device.
Returns the last known location of the device.
Returns the location.
This location may be a recently cached location.
Returns the current location of the device.
Returns the location.
The criteria to use when determining the location of the device.
Returns the current location of the device using the specified criteria.
Returns the location.
The criteria to use when determining the location of the device.
A token for cancelling the operation.
Returns the current location of the device using the specified criteria.
Returns the location.
Represents levels of accuracy when determining location.
Represents the best accuracy, using the most power to obtain and typically within 10 meters.
Represents default accuracy (Medium), typically within 30-500 meters.
Represents high accuracy, typically within 10-100 meters.
Represents low accuracy, typically within 300-3000 meters.
Represents the lowest accuracy, using the least power to obtain and typically within 1000-5000 meters.
Represents medium accuracy, typically within 30-500 meters.
Represents the criteria for a location request.
Creates a new instance of GeolocationRequest.
The desired accuracy.
Creates a new instance of GeolocationRequest with the specified accuracy.
The desired accuracy.
The request timeout.
Creates a new instance of GeolocationRequest with the specified accuracy and timeout.
Gets or sets the desired accuracy of the resulting location.
The desired accuracy of the location.
Gets or sets the location request timeout.
The location request timeout.
A string representation of the request.
A string representation of the request.
To be added.
Gyroscope data of the rotation around the device's three primary axis.
Gets if gyro is being monitored.
If monitoring.
Event triggered when reading of sensor changes.
Speed to monitor sensor.
Start monitoring for changes to gyro.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
Stop monitoring for changes to gyro.
Event arguments containing the current reading.
The current reading of the gyroscope
public constructor
To be added.
Gets the reading of the gyro.
The reading.
Gyroscope information.
X data
Y data
Z data
Public constructor
To be added.
X data
Y data
Z data
Public constructor.
To be added.
Gets the angular velocity vector in radians per second.
Object to compare
If equal to another object
If equal
Other GyroscopeData to compare with.
Compares the underlying Vector3 instances.
True if they match, otherwise false.
Get the hash code for object.
The hash code
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
A string representation of the data.
A string representation of the data.
To be added.
Provides methods to control HapticFeedback responses
The type of a HapticFeedback response that will be called
Calls the platform-oriented method to cause a HapticFeedback response of the specified type
Enumerates the possible types of HapticFeedback response
Click
LongPress
Launches an application specified by the passed uri.
Has to be a valid System.Uri
string uri scheme
Queries if device supports opening the uri scheme
True if opening is supported, otherwise false
May throw System.UriFormatException if uri is malformed
uri scheme
Queries if device supports opening the uri scheme
True if opening is supported, otherwise false
May throw System.UriFormatException if uri is malformed
string uri scheme
Launches the app specified by the uri scheme
May throw System.UriFormatException if uri is malformed. Verify if the uri scheme is supported before calling this method
uri scheme
Launches the app specified by the uri scheme
May throw System.UriFormatException if uri is malformed. Verify if the uri scheme is supported before calling this method
Request that contains information on the file to open.
Requests to open a file in an application based on content type.
string uri scheme
Launches the app specified by the uri scheme and returns if it was supported or not
True if opening is supported, otherwise false
May throw System.UriFormatException if uri is malformed
uri scheme
Launches the app specified by the uri scheme and returns if it was supported or not
True if opening is supported, otherwise false
May throw System.UriFormatException if uri is malformed
Represents a specific geographical, political, or cultural region.
Country name or code.
This value may vary between platforms.
Unique Id of the Locale.
Language name or code.
This value may vary between platforms.
Display name of the Locale.
The latitude, longitude, altitude and time information reported by the device.
Default constructor.
Location to copy values from.
Copy constructor.
Default latitude for location.
Default longitude for location.
Parametrized constructor with latitude and longitude parameters.
Default latitude for location.
Default longitude for location.
Timestamp for the location (Utc based).
Parametrized constructor with latitude, longitude and timestamp parameters.
Default latitude for location.
Default longitude for location.
To be added.
Parametrized constructor with latitude, longitude and altitude parameters.
Gets or sets the horizontal accuracy (in meters) of the location.
The horizontal accuracy of the location.
Gets the altitude in meters (if available) in a reference system which is specified by AltitudeReferenceSystem.
Altitude of location if available.
Returns 0 or no value if not available.
Specifies the reference system in which the altitude value is given.
The altitude reference system.
To be added.
Start location to calculate from.
End location to calculate from.
Units to return.
Calculate distance between two locations.
Distance between two locations in the unit selected.
Start latitude to calculate from.
Start longitude to calculate from.
End location to calculate from.
Unit to return.
Calculate distance between two locations.
Distance calculated.
Start location to calculate from.
End latitude to calculate from.
End longitude to calculate from.
Unit to use.
Calculate distance between two locations.
Distance calculated.
Start latitude to calculate from.
Start longitude to calculate from.
End latitude to calculate from.
End longitude to calculate from.
Units to return.
Calculate distance between two locations.
Distance between two locations in the unit selected.
Degrees relative to true north.
0..360 in degrees relative to true north. null if unavailable.
Requires a high accuracy query of location and may not be returned by Geolocation.GetLastKnownLocationAsync
Inform if location is from GPS or from Mock.
True if is from Mock and False if from GPS.
Gets or sets the latitude of location.
Latitude of the location.
Gets or sets the longitude of location.
Longitude of the location.
Speed in meters per second.
Speed measured by the device..
Gets or sets the timestamp of the location.
UTC timestamp.
A string representation of the location.
A string representation of the location.
To be added.
Gets or sets the vertical accuracy (in meters) of the location.
The vertical accuracy of the location.
Location Extensions
Start location to calculate from.
End location to calculate from.
Units to use during calculation.
Extension to calculate distance from location to another location.
Distance in units fro two locations.
Start location to calculate from.
End latitude to calculate from.
End longitude to calculate from.
Units to use.
Extension to calculate distance from location to another location.
Distance calculated.
Location to open to.
Open maps to this location.
Task to wait.
Location to open to.
Options to use.
Open maps to this location.
Task to wait.
Detect device's orentation relative to Earth's magnetic field in microteslas (µ).
Gets if magnetometer is being monitored.
If monitoring.
Event triggered when reading of sensor changes.
Speed to get sensor information.
Start monitoring for changes to magnetometer.
Will throw FeatureNotSupportedException if not supported on device. Will throw ArgumentNullException if handler is null.
Stop monitoring for changes to magnetometer.
Event arguments containing the current reading.
Current reading of data
Public constructor
To be added.
Gets the reading of the magnetometer.
The reading.
Data for magnetometer changes.
X data
Y data
Z data
Public constructor
To be added.
X data
Y data
Z data
Public constructor
To be added.
Object to compare
If equal to another object
If equal
Other MagnetometerData to compare with.
Compares the underlying Vector3 instances.
True if they match, otherwise false.
Get the hash code for object.
The hash code
Gets the magnetic field vector in microteslas (µ).
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
A string representation of the data.
A string representation of the data.
To be added.
Main Thread helpers.
Main Thread helpers.
Action to execute.
Invokes an action on the main thread of the application.
Gets the main thread synchonization context
The syncrhonization context for the main thread
To be added.
Action to invoke
Invoke the main thread aysnc
A task that can be awaited
To be added.
A function task to execute
Invoke the main thread aysnc
A task that can be awaited
To be added.
To be added.
A function task to execute
Invoke the main thread aysnc
A task that can be awaited
To be added.
To be added.
A function to execute
Invoke the main thread aysnc
A task that can be awaited
To be added.
Gets if it is the current main UI thread.
If main thread.
Map helpers to open a route to specified places via default platforms maps implementation.
Location to open on maps.
Open the installed application to a specific location.
Task to be completed.
Placemark to open on maps.
Open the installed application to a specific placemark.
Task to be completed.
Latitude to open to.
Longitude to open to.
Open the installed application to a specific location.
Task to be completed.
Location to open maps to.
Launch options to use.
Open the installed application to a specific location with launch options.
Task to be completed.
Placemark to open maps to.
Launch options to use.
Open the installed application to a specific placemark with launch options.
Task to be completed.
Latitude to open to.
Longitude to open to.
Launch options to use.
Open the installed application to a specific location.
Task to be completed.
Launch options for opening a map.
To be added.
Public constructor
To be added.
Name of destination to display to user.
Gets the name.
The navigation mode to use.
Gets the navigation mode.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Represents various modes of navigation.
Default is none.
Bicycle route mode.
The default navigation mode on the platform.
Car route mode.
No navigation mode for map.
Transit route mode.
Walking route mode.
Various states of the connection to the internet.
Limited internet access.
Local and Internet access.
Local network access only.
No connectivity.
The state of the connectivity is not known.
Exception that occurs when executed from a reference assembly. This usually means that the NuGet was not installed into the app project.
Default constructor.
Standard request for opening a file to another application.
Open request with an existing file.
Title to display on open dialog if available.
File to open.
Open request with an existing file.
Title to display on open dialog if available.
File to open.
Open request with an existing file.
File to open.
Gets or sets the source rectangle to display the Share UI from.
This is only used on iOS currently.
Title to display on open dialog if available.
Device orientation (quaternion) relative to magnetic fields.
Gets of currently monitoring the sensor.
If monitoring.
Event triggered when reading of sensor changes.
Sensor speed to use.
Starts monitoring orientation sensor with specific speed.
Stops monitoring.
Orientation event args when reading changes.
Reading of the sensor data
Public constructor
To be added.
Gets the reading when it changes.
The current Reading
Sensor data for orientation.
X data
Y data
Z data
W data
Public constructor
To be added.
X data
Y data
Z data
W data
Public constructor
To be added.
Object to compare
If equal to another object
If equal
Other OrientationSensorData to compare with.
Compares the underlying Quaternion instances.
True if they match, otherwise false.
Get the hash code for object.
The hash code
Left to compare
Right to compare
Equality operator for equals
If equal
Left to check
Right to check
Inequality check
If not equal
Gets the current orientation that represents a Quaternion.
Gets the current orientation
A string representation of the data.
A string representation of the data.
To be added.
Exception that occures when calling an API that requires a specific permission.
Permission that is required.
Constructor with permission information.
Access to checking and requesting application permissions.
The permission to check.
Checks the status of a specific permission.
The current status of the permission.
Name of the capability on UWP.
Checks if a specific capability name is declared.
If the capability is declared.
The name of the specific permission in the manifest to check.
Checks if a permission is declared in the Android manifest file.
If the permission is declared or not.
The usage key to check in the info.plist.
Check if a usage key is specified in the info.plist file.
If it is declared in the info.plist.
Gets or sets the location timeout for iOS when switching between when in use and always.
The specific TimeSpan to use in this time.
This is a special use case where the user is promoted for location permission which was already granted. iOS does not return a value and a timeout must be actived. The default is 10 seconds.
The permission to request.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
The type of permission.
Gets whether you should show UI with rationale for requesting a permission.
Returns true if rationale should be displayed, otherwise false.
Base permission, used internally.
To be added.
public constructor for the base permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Ensures that all permissions are decalred.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Gets whether you should show UI with rationale for requesting a permission.
A boolean if the user has declined the permission in the past and UI should be shown.
Only relevant on Android after a user had denied a permission one time.
Base platform permission, used internally.
To be added.
Public constructor for base platform permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Ensures that all permissions are declared.
To be added.
To be added.
To be added.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required declarations.
List of required declarations.
To be added.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Gets whether you should show UI with rationale for requesting a permission.
A boolean if the user has declined the permission in the past and UI should be shown.
Only relevant on Android after a user had denied a permission one time.
Permission for battery
To be added.
Public constructor for permission.
To be added.
Check status of Battery permission.
Task of PermissionStatus for Battery.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to read the calendar
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
To be added.
To be added.
To be added.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to write to the calendar.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
To be added.
To be added.
To be added.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to access the camera.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to read contacts.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
To be added.
To be added.
To be added.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to write contacts
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
To be added.
To be added.
To be added.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to access events.
To be added.
Public constructor for permission.
To be added.
Permissiont to access the flashlight.
To be added.
Public constructor for permission.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permissions to launch an app.
To be added.
Public constructor for permission.
To be added.
Permission for geolocation always.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required declarations.
List of required declarations.
To be added.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission for geolocation when the app is in use.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
To be added.
To be added.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required declarations.
List of required declarations.
To be added.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to access maps.
To be added.
Public constructor for permission.
To be added.
Permission to access media on device.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Permission to access the microphone.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required declarations.
List of required declarations.
To be added.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to access the network state.
To be added.
Public constructor for permission.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to access the phone.
To be added.
Public constructor for permission.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to access the photo album.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Permission to access reminders.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Permission to access device sensors.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to access Sms capabilities on device.
To be added.
Public constructor for permission.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to access speech capabilities on device.
To be added.
Public constructor for permission.
To be added.
Checks the status of a specific permission.
The current status of the permission.
To be added.
Request a specific permission from the user.
The status of the permission that was requested.
The request will be prompted to the user if it hasn't been granted. iOS only allows the permission to be requested once, any additional requests will return immediatelly.
Get a list of required keys in the info.plist.
List of required keys in the info.plist.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to read storage.
To be added.
Public constructor for permission.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to write to storage.
To be added.
Public constructor for permission.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Permission to vibrate device.
To be added.
Public constructor for permission.
To be added.
Get a list of required permissions.
List of required permissions.
To be added.
Status of the permission.
The user has denied the permission.
The permission is disabled for the app.
The user has granted permission.
The permission is in a restricted state.
The permission hasn't been granted or requested and is in an unknown state.
Open the platform phone dialer to place a call.
Phone number to initialize the dialer with. Example 15555555555
Open the phone dialer to a specific phone number.
Throws ArgumentNullException if number is not valid.
Throws FeatureNotSupportedException if placing phone call is not supported on the device.
File picking options.
This file picking options object can be passed to a call to PickAsync().
Creates a default PickOptions object.
Default file picking options
A PickOptions object with default values.
This object can be used when no special pick options are necessary.
List of file types that file file picker should return.
On Android and iOS the files not matching this list is only displayed grayed out.
When the array is null or empty, all file types can be selected while picking.
The contents of this array is platform specific; every platform has its own way to
specify the file types.
On Android you can specify one or more MIME types, e.g.
"image/png"; also wild card characters can be used, e.g. "image/*".
On iOS you can specify UTType constants, e.g. UTType.Image.
On UWP, specify a list of extensions, like this: ".jpg", ".png".
Predefined PickOptions object for picking image files only.
Due to specifying the file types to pick being very platform specific, this predefined
PickOptions object can be used for picking images.
Title for the file picker.
Note that the file picker title is only used on the Android platform.
User-friendly description of a geographic coordinate. This contains information such as the name of the place, its address, and other information.
Default constructor for placemark.
Placemark to copy.
Constructor to create a deep copy.
Gets or sets the administrative area name of the address, for example, "CA", or null if it is unknown.
The admin area.
Gets or sets the country ISO code.
The country ISO code.
Gets or sets the country name.
The country name.
Gets or sets the feature name.
The feature name.
Gets or sets the city or town.
The city or town of the locality.
Gets or sets the location of the placemark.
The location of the placemark.
Gets or sets the postal code.
The postal code.
Gets or sets the sub-administrative area name of the address, for example, "Santa Clara County", or null if it is unknown.
The sub-admin area.
Gets or sets the sub locality.
The sub locality.
Gets or sets optional info: sub street or region.
The sub thoroughfare.
Gets or sets the street name.
The street name.
A string representation of the placemark.
Returns a string representation of the placemark.
Extensions for the placemark.
To be added.
The placemark to open the map to.
Open the map to the placemark.
To be added.
A placemark to open the map to.
Options for opening the map.
Open the map to the placemark with options.
To be added.
To be added.
Platform specific helpers.
Event that is triggered when any Android Activity's state changes.
The current application's context.
The applications context.
The application.
The user activity instance.
The completion handler.
Callback forwarded from the equivalent iOS AppDelegate method.
True if the callback was handled.
Gets the current Activity. This value is set OnCreate, OnPause, and OnResume.
The current Activity or null if none or Init was not called.
Get the currently visible UIViewController.
The visible UIViewController or null if not found.
Application to initialize with.
Initialize Xamarin.Essentials with Android's application class.
Activity to use for initialization.
Bundle of the activity.
Initialize Xamarin.Essentials with Android's activity and bundle.
Get or sets the map API key.
The current key for maps.
Needed only for UWP and can be generated from Bing Maps.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
The requestCode from the corresponding overridden method in an activity.
The permissions from the corresponding overridden method in an activity.
The grantResults from the corresponding overridden method in an activity.
Pass permission request results from an activity's overridden method to the library for handling internal permission requests.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Passes the OpenUrl callback of your app to be used for internal API handling.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Cancellation token to stop waiting for Activity to be created or active.
Wait for an Activity to be create or active.
The current Android Activity.
To be added.
To be added.
To be added.
To be added.
Extension methods for Point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
The point to convert.
Converts the point ot the system representation.
The converted point.
A class to interact with the preferences/settings of the native platform.
Each platform uses the platform provided native APIs for storing application/user preferences:
-
iOS: NSUserDefaults
-
Android: SharedPreferences
-
UWP: ApplicationDataContainer
Clears all keys and values.
Shared container name.
Clears all keys and values.
Preference key.
Checks the existence of a given key.
Returns true if the key exists.
Preference key.
Shared container name.
Checks the existence of a given key.
Returns true if the key exists.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Default value to return if the key does not exist.
Shared container key.
Gets the value for a given key, or the default specified if the key does not exist.
Value for the given key, or the default if it does not exist.
Preference key.
Removes a key and its associated value if it exists.
Preference key.
Shared container name.
Removes a key and its associated value if it exists.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
Preference key.
Preference value.
Shared container name.
Sets a value for a given key.
A representation of a file and its content type.
Full file path.
Construct a file taking in file path.
File to use for ReadOnlyFile
Construct a file taking in file.
Full file path.
Content type (MIME type) of the file (eg: `image/png`).
Construct a file taking in file path and content type (MIME type).
Extension methods for Rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
The base rectangle to convert.
Convert to system rectangle.
The converted rectangle.
Take a screenshot depicting the current View.
Capture the screen.
Returns the caprured screenshot.
Gets a value indicating whether capturing screenshots are supported.
The format to read screenshot images.
Read the screenshot image as a JPEG.
Read the screenshot image as a PNG.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
To be added.
Provides simple secure storage for key/value pairs.
Each platform uses the platform provided native API's for storing data securely:
-
iOS: Data is stored in KeyChain. Additional information on SecAccessible at:
-
Android: Encryption keys are stored in KeyStore and encrypted data is stored in a named shared preference container (PackageId.Xamarin.Essentials).
-
UWP: Data is encrypted with DataProtectionProvider and stored in a named ApplicationDataContainer (with a container name of ApplicationId.Xamarin.Essentials).
NOTE: On Android devices running below API 23 (6.0 Marshmallow) there is no AES available in KeyStore. As a best practice this API will generate an RSA/ECB/PKCS7Padding key pair stored in KeyStore (the only type supported in KeyStore by these lower API levels), which is used to wrap an AES key generated at runtime. This wrapped key is stored in Preferences.
iOS: Default SecAccessible to use for all Get/Set calls to KeyChain. Default value is AfterFirstUnlock.
The SecAccessible to use for all KeyChain access.
For more information see:
Storage Key.
Gets the decrypted value for a given Key.
Decrypted string or null if key does not exist.
When set to `true` if the key/value pair is not found, the MD5 key hash is also used to attempt to locate a value.
Before version 1.5.3, the key/value pair was stored with the key's MD5 hash instead of the key directly. As of 1.5.3 and newer the key hash is no longer used. When using the legacy fallback, and an old MD5 key hash is encountered, it is migrated to the new key/value pair and the old MD5 key hash / value pair is removed. In future versions this will be set to false by default.
The key to remove.
Removes the encrypted key/value pair for the given key.
Returns true if the key value pair was removed.
Removes all of the stored encrypted key/value pairs.
Storage Key.
The value to be encrypted.
Stores the value which is encrypted, for a given Key.
Storage Key.
The value to be encrypted.
The KeyChain accessibility to create the encrypted record with.
Stores the value which is encrypted, for a given Key. iOS override to specify SecAccessible for the KeyChain.
Sensor speed to monitor for changes.
The default sensor speed.
Get the sensor data as fast as possible.
Rate suitable for games.
Rate suitable for general user interface.
Share data such as text and uris to other applications.
Text to share.
Show the share user interface to share text.
Task when completed.
File request to share.
Show the user interface to share a file.
Task when completed.
Multiple Files request to share.
Show the user interface to share a multiple files.
Task when completed.
Share request with options.
Show the share user interface to share text or uri.
Task when completed.
Text to share.
Title for the share user interface.
Show the share user interface to share text with a title.
Task when completed.
A file to be shared.
The full path and filename.
File to be shared.
Existing file to be shared.
Shares an existing file.
Full path and filename.
Explicit content type (MIME type) of the file (eg: `image/png`).
Standard request for sharing a file to another application.
Default constructor.
Existing file.
Share request with an existing file.
Existing file.
Share request with an existing file.
Title to use on the share user interface.
Existing file.
Share request with an existing file.
Title to use on the share user interface.
Existing file.
Share requerst with an existing file.
Gets or sets the file to share.
Standard request for sharing a multiple files to another application.
Default constructor.
Existing files.
Share request with an existing files.
Existing files.
Share request with an existing files.
Title to use on the share user interface.
Existing files.
Share request with an existing files.
Title to use on the share user interface.
Existing files.
Share requerst with an existing files.
Gets or sets the files to share.
The request to convert into a multi-file request.
Convert a single file share request into a multi-file share request.
Returns a multi-file share request containing the single file.
Gets or sets the source rectangle to display the Share UI from.
This is only used on iOS currently.
Gets or sets the title to use on the share user interface
The title to be displayed.
Standard request for sharing text to other applications.
Default constructor.
Text to share.
Share request with text.
Text to share.
Title for share user interface.
Share request with text and title.
Gets or sets the subject that is sometimes used for applications such as mail clients.
The subject.
Gets or sets the main text or message to share.
The main text.
Gets or sets a valid Uri to share.
The uri that will be shared.
This must be a valid uri or an exception will be thrown.
Extension methods for Size.
Base size to convert.
Convert to system Size.
Converted size.
Base size to convert.
Convert to system Size.
Converted size.
Base size to convert.
Convert to system Size.
Converted size.
Base size to convert.
Convert to system SizeF.
Converted size.
Base size to convert.
Convert to system SizeF.
Converted size.
Base size to convert.
Convert to system SizeF.
Converted size.
Provides an easy way to allow the user to send SMS messages.
Opens the default SMS client to allow the user to send the message.
The message to send.
Opens the default SMS client to allow the user to send the message.
Represents a single SMS message.
Creates a new instance of SmsMessage
Content of the message
Recipients to receive the message.
Creates a new instance of SmsMessage
Content of the message
Recipient to receive the message.
Creates a new instance of SmsMessage
Gets the body of the message.
Gets the recipient of the message.
Text-to-speech options.
Gets or Sets a specific Locale to use with text to speech.
The Language property should match a Locale value returned by GetLocalesAsync().
The pitch to use when speaking.
This value should be between 0f and 2.0f.
The volume to use when speaking.
This value should be between 0f and 1.0f.
Speak text to Speech
Gets a list of Locales supported by Text to Speech.
The text to speak..
Optional cancellation token to stop speaking.
Speaks the given text with default options.
The text to speak.
The options to use for speaking.
Optional cancellation token to stop speaking.
Speaks the given text with the specified options.
Built in unit converters
To be added.
Atmospheres to convert
Atmospheres to Pascals
The pascals value
To be added.
The temperature in celsius to convert
Celsius to Fahrenheit
The temperature in fahrenheit
To be added.
The temperature in Celsius to convert
Celsius to Kelvin
The temperature in Kelvin
To be added.
First latitude
First longitude
Second latitude
Second longitude
Calulate the distance between two coordinate in kilometers
Distance in kilometers
To be added.
First latitude
First longitude
Second latitude
Second longitude
Calulate the distance between two coordinate in miles
Distance in miles
To be added.
The degrees to convert
Converte degrees per second to hertz
Value in hertz
To be added.
Degrees to convert
Convert degrees per second to radians per second
Value in radians
To be added.
Degrees to convert
Convert degrees to radian
The value in radians
To be added.
The value in fahrenheit to convert
Converter fahrenheit to celsius
The value in celsius
To be added.
Hectopascals to convert
Convert hectopascals to kilopascals
The value in kilopascals
To be added.
The value to convert in Hectopascals
Convert hectopascals to pascals
The value in pascals
To be added.
The value in hertz to convert
Convert hertz to degrees per second
The value in degrees per second
To be added.
The value in hertz to convert
Convert hertz to radians per second
The value in radians per second
To be added.
The feet to convert
Convert international feet to meters
The value in meters
To be added.
The kelvin value to convert
Convert kelvin to celsius
The value in celsius
To be added.
The value in kilograms to convert
Convert kilograms to pounds
The value in pounds.
To be added.
The kilometers to convert
Convert kilometers to miles
The value in miles.
To be added.
The value in kilopascals to convert
Convert kilopascals to hectopascals
The value in hectopascals
To be added.
The value in kilopascals to convert
Convert kilopascals to pascals
The value in pascals
To be added.
The value in meters to convert
Convert meters to international feet
The value in feet
To be added.
The value in meters to convert
Convert meters to US survey feet
The value in US survey feet
To be added.
The value in miles to convert
Convert miles to kilometers
The value in kilometers
To be added.
The value in miles to convert
Convert miles to meters
The value in meters
To be added.
The value in pascals to convert
Convert pascals to atmospheres
The value in atmospheres
To be added.
The value in pounds to convert
Convert pounds to kilograms
The value in kilograms
To be added.
The value in pounds to convert
Convert pounds to stones
The value in stones
To be added.
The value of radians per second to convert
Convert radians per second to degrees per second
The value in degrees per second
To be added.
The value of radians per second to convert
Convert radians per second to hertz
The value in hertz
To be added.
The value in radians to convert
Convert radians to degrees
The value in degrees
To be added.
The value in stones to convert
Convert stones to pounds
The value in pounds
To be added.
The value in US Survey Feet to convert
Convert US survey feet to meteres
The value in meters.
To be added.
Provides an easy way to track an app's version on a device.
Gets the collection of build numbers of the app that ran on this device.
Gets the current build of the app.
Gets the current version number of the app.
Gets the build number of first version of the app that was installed on this device.
Gets the version number of the first version of the app that was installed on this device.
Gets a value indicating whether this is the first time this app has ever been launched on this device.
The build number.
Determines if this is the first launch of the app for a specified build number.
Returns true if this is the first launch of the app for the specified build number; otherwise false.
Gets a value indicating if this is the first launch of the app for the current build number.
Gets a value indicating if this is the first launch of the app for the current version number.
The version number.
Determines if this is the first launch of the app for a specified version number.
Returns true if this is the first launch of the app for the specified version number; otherwise false.
Gets the build number for the previously run version.
Gets the version number for the previously run version.
Starts tracking version information.
Gets the collection of version numbers of the app that ran on this device.
Provides an easy way to make the device vibrate.
Cancel any current vibrations.
Vibrate the device fo 500ms.
The number of milliseconds to vibrate for.
Vibrate the device for the specified number of milliseconds in the range [0, 5000].
On iOS, the device will only vibrate for 500ms, regardless of the value specified.
The time to vibrate for.
Vibrate the device for the specified time in the range [0, 5000]ms.
On iOS, the device will only vibrate for 500ms, regardless of the value specified.
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.
Url to navigate to, beginning the authentication flow.
Expected callback url that the navigation flow will eventually redirect to.
Begin an authentication flow by navigating to the specified url and waiting for a callback/redirect to the callbackUrl scheme.
Returns a result parsed out from the callback url.
The activity meant to be subclassed and implemented to receive callbacks on Android.
This activity should be decorated with the appropriate Intent Filter to handle callbacks to the appropriate URI scheme.
To be added.
To be added.
This method should be called from the same method in the parent activity which initiated the web authentication.
Web Authenticator Result parsed from the callback Url.
All of the querystring or url fragment properties are parsed into a dictionary and can be accessed by their key.
To be added.
To be added.
Create a new instance from an existing dictionary.
To be added.
To be added.
Create a new instance by parsing a Uri's querystring parameters.
To be added.
The value for the `access_token` key.
Access Token parsed from the callback URI access_token parameter.
The expiry date as calculated by the timestamp of when the result was created plus the value in seconds for the `expires_in` key.
Timestamp of the creation of the object instance plus the expires_in seconds parsed from the callback URI.
Key from the callback URI's query string.
Gets a value for a given key from the dictionary.
The value for the `id_token` key.
The value for the `id_token` key.
Apple doesn't return an access token on iOS native sign in, but it does return id_token as a JWT.
The dictionary of key/value pairs parsed form the callback URI's querystring.
Puts a key/value pair into the dictionary.
The value for the `refresh_token` key.
Refresh Token parsed from the callback URI refresh_token parameter.
The refresh token expiry date as calculated by the timestamp of when the result was created plus the value in seconds for the refresh_token_expires_in key.
Timestamp of the creation of the object instance plus the expires_in seconds parsed from the callback URI.
The timestamp when the class was instantiated, which usually corresponds with the parsed result of a request.