| title | description | ms.date | no-loc | ||
|---|---|---|---|---|---|
Share |
Learn how to use the .NET MAUI IShare interface, which can share data, such as web links, to other applications on the device. |
02/02/2023 |
|
Browse the sampleThis article describes how you can use the .NET Multi-platform App UI (.NET MAUI) xref:Microsoft.Maui.ApplicationModel.DataTransfer.IShare interface. This interface provides an API to send data, such as text or web links, to the devices share function.
The default implementation of the IShare interface is available through the xref:Microsoft.Maui.ApplicationModel.DataTransfer.Share.Default?displayProperty=nameWithType property. Both the IShare interface and Share class are contained in the Microsoft.Maui.ApplicationModel.DataTransfer namespace.
When a share request is made, the device displays a share window, prompting the user to choose an app to share with:
:::image type="content" source="media/share/share.png" alt-text="Share from your app to a different app":::
To access the Share functionality, the following platform-specific setup is required:
No setup is required.
If your application is going to share media files, such as photos and videos, you must add the following keys to your Platforms/iOS/Info.plist and Platforms/MacCatalyst/Info.plist files:
<key>NSPhotoLibraryAddUsageDescription</key>
<string>This app needs access to the photo gallery to save photos and videos.</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>This app needs access to the photo gallery to save photos and videos.</string>The <string> elements represent the text shown to your users when permission is requested. Make sure that you change the text to something specific to your application.
No setup is required.
The share functionality works by calling the xref:Microsoft.Maui.ApplicationModel.DataTransfer.IShare.RequestAsync%2A method with a data payload that includes information to share to other applications. xref:Microsoft.Maui.ApplicationModel.DataTransfer.ShareTextRequest.Text?displayProperty=nameWithType and xref:Microsoft.Maui.ApplicationModel.DataTransfer.ShareTextRequest.Uri?displayProperty=nameWithType can be mixed and each platform will handle filtering based on content.
:::code language="csharp" source="../snippets/shared_1/DataPage.xaml.cs" id="share_text_uri":::
You can also share files to other applications on the device. .NET MAUI automatically detects the file type (MIME) and requests a share. However, operating systems may restrict which types of files can be shared. To share a single file, use the xref:Microsoft.Maui.ApplicationModel.DataTransfer.ShareFileRequest type.
The following code example writes a text file to the device, and then requests to share it:
:::code language="csharp" source="../snippets/shared_1/DataPage.xaml.cs" id="share_file":::
Sharing multiple files is slightly different from sharing a single file. To share a single file, use the xref:Microsoft.Maui.ApplicationModel.DataTransfer.ShareMultipleFilesRequest type.
The following code example writes two text files to the device, and then requests to share them:
:::code language="csharp" source="../snippets/shared_1/DataPage.xaml.cs" id="share_file_multiple":::
[!INCLUDE ios-PresentationSourceBounds]
This section describes the platform-specific differences with the share API.
- The xref:Microsoft.Maui.ApplicationModel.DataTransfer.ShareTextRequest.Subject?displayProperty=nameWithType property is used for the desired subject of a message.
- The xref:Microsoft.Maui.ApplicationModel.DataTransfer.ShareTextRequest.Subject?displayProperty=nameWithType property isn't used.
- The xref:Microsoft.Maui.ApplicationModel.DataTransfer.ShareRequestBase.Title?displayProperty=nameWithType property will default to the application name if not set.
- The xref:Microsoft.Maui.ApplicationModel.DataTransfer.ShareTextRequest.Subject?displayProperty=nameWithType property isn't used.