Xamarin.Essentials の概要Get Started with Xamarin.Essentials

Xamarin.Essentials には、任意の iOS、Android、または UWP アプリケーションと連携する単一のクロスプラットフォーム API が用意されています。ユーザー インターフェイスの作成方法に関係なく、共有コードからアクセスできます。Xamarin.Essentials provides a single cross-platform API that works with any iOS, Android, or UWP application that can be accessed from shared code no matter how the user interface is created. サポートされているオペレーティング システムについて詳しくは、プラットフォームと機能のサポート ガイドに関するページをご覧ください。See the platform & feature support guide for more information on supported operating systems.

インストールInstallation

Xamarin.Essentials は NuGet パッケージとして入手可能で、Visual Studio を使用して既存または新規の任意のプロジェクトに追加できます。Xamarin.Essentials is available as a NuGet package that can be added to any existing or new project using Visual Studio.

  1. Xamarin 用の Visual Studio ツールと共に、Visual Studio をダウンロードしてインストールします。Download and install Visual Studio with the Visual Studio tools for Xamarin.

  2. 既存のプロジェクトを開くか、Visual Studio C# (Android、iPhone と iPad、またはクロスプラットフォーム) の下の空のアプリ テンプレートを使用して新しいプロジェクトを作成します。Open an existing project, or create a new project using the Blank App template under Visual Studio C# (Android, iPhone & iPad, or Cross-Platform).

    重要

    UWP プロジェクトに追加する場合、プロジェクトのプロパティにビルド 16299 以上が設定されていることを確認します。If adding to a UWP project ensure Build 16299 or higher is set in the project properties.

  3. 各プロジェクトに Xamarin.Essentials の NuGet パッケージを追加します。Add the Xamarin.Essentials NuGet package to each project:

    ソリューション エクスプローラー パネルでソリューション名を右クリックし、 [NuGet パッケージの管理] を選択します。In the Solution Explorer panel, right click on the solution name and select Manage NuGet Packages. Xamarin.Essentials を検索し、Android、iOS、UWP、.NET Standard ライブラリなど、すべてのプロジェクトにパッケージをインストールします。Search for Xamarin.Essentials and install the package into ALL projects including Android, iOS, UWP, and .NET Standard libraries.

  4. Xamarin.Essentials への参照を任意の C# クラスに追加して、API を参照します。Add a reference to Xamarin.Essentials in any C# class to reference the APIs.

    using Xamarin.Essentials;
    
  5. Xamarin.Essentials では、プラットフォーム固有の設定が必要です。Xamarin.Essentials requires platform-specific setup:

    Xamarin.Essentials では最小の Android バージョン 4.4 (API レベル 19 に対応) がサポートされていますが、コンパイルのターゲットの Android バージョンは 9.0 (API レベル 28 に対応) である必要があります。Xamarin.Essentials supports a minimum Android version of 4.4, corresponding to API level 19, but the target Android version for compiling must be 9.0, corresponding to API level 28. (Visual Studio では、これらの 2 つのバージョンは、[Android マニフェスト] タブ内の、Android プロジェクトの [プロジェクトのプロパティ] ダイアログで設定されます。Visual Studio for Mac では、これらは [Android アプリケーション] タブ内の、Android プロジェクトの [プロジェクト オプション] ダイアログで設定されます。)(In Visual Studio, these two versions are set in the Project Properties dialog for the Android project, in the Android Manifest tab. In Visual Studio for Mac, they're set in the Project Options dialog for the Android project, in the Android Application tab.)

    Xamarin.Essentials では、必要なバージョン 28.0.0.1 の Xamarin.Android.Support ライブラリがインストールされます。Xamarin.Essentials installs version 28.0.0.1 of the Xamarin.Android.Support libraries that it requires. アプリケーションで必要となるその他の Xamarin.Android.Support ライブラリも、NuGet パッケージ マネージャーを使用してバージョン 28.0.0.1 に更新する必要があります。Any other Xamarin.Android.Support libraries that your application requires should also be updated to version 28.0.0.1 using the NuGet package manager. アプリケーションで使用される Xamarin.Android.Support ライブラリはすべて同じであり、かつ少なくともバージョン 28.0.0.1 以上である必要があります。All Xamarin.Android.Support libraries used by your application should be the same, and should be at least version 28.0.0.1. Xamarin.Essentials の NuGet の追加、またはソリューションでの NuGet の更新に関して問題が発生した場合は、トラブルシューティングのページを参照してください。Refer to the troubleshooting page if you have issues adding the Xamarin.Essentials NuGet or updating NuGets in your solution.

    Android プロジェクトの MainLauncher、または起動されるすべての Activity では、OnCreate メソッド内で Xamarin.Essentials を初期化する必要があります。In the Android project's MainLauncher or any Activity that is launched Xamarin.Essentials must be initialized in the OnCreate method:

    protected override void OnCreate(Bundle savedInstanceState) {
        //...
        base.OnCreate(savedInstanceState);
        Xamarin.Essentials.Platform.Init(this, savedInstanceState); // add this line to your code, it may also be called: bundle
        //...
    

    Android 上で実行時のアクセス許可を処理するには、Xamarin.Essentials がすべての OnRequestPermissionsResult を受け取る必要があります。To handle runtime permissions on Android, Xamarin.Essentials must receive any OnRequestPermissionsResult. すべての Activity クラスに次のコードを追加します。Add the following code to all Activity classes:

    public override void OnRequestPermissionsResult(int requestCode, string[] permissions, [GeneratedEnum] Android.Content.PM.Permission[] grantResults)
    {
        Xamarin.Essentials.Platform.OnRequestPermissionsResult(requestCode, permissions, grantResults);
    
        base.OnRequestPermissionsResult(requestCode, permissions, grantResults);
    }
    
  6. Xamarin.Essentials のガイドに従ってください。各機能に対するコード スニペットをコピーして貼り付けることができます。Follow the Xamarin.Essentials guides that enable you to copy and paste code snippets for each feature.

Xamarin.Essentials - モバイル アプリ用クロスプラットフォーム API (ビデオ)Xamarin.Essentials - Cross-Platform APIs for Mobile Apps (video)

その他の参照情報Other Resources

Xamarin を使用したことがない開発者は、Xamarin 開発の概要に関するページを参照することをお勧めします。We recommend developers new to Xamarin visit getting started with Xamarin development.

現在のソース コード、今後の内容、サンプルの実行、リポジトリの複製について確認するには、Xamarin.Essentials の GitHub リポジトリをご覧ください。Visit the Xamarin.Essentials GitHub Repository to see the current source code, what is coming next, run samples, and clone the repository. コミュニティへの投稿も歓迎します。Community contributions are welcome!

Xamarin.Essentials のすべての機能の API ドキュメントを参照します。Browse through the API documentation for every feature of Xamarin.Essentials.