VpnChannel.ActivateForeground(String, ValueSet) メソッド

定義

名前空間:

Windows.Networking.Vpn

フォアグラウンドで VPN アプリをアクティブにします。 これは、ユーザーが資格情報を入力できるようにするためによく使用されます。 ActivateForeground は、IVpnPlugin.Connectの実装からのみ呼び出すことができます。 アプリがフォアグラウンドにある間は、通常の Connect タイムアウトが一時停止されます。

ActivateForeground 呼び出しは、長い一時停止 (約 10 分) がある場合にキャンセルされます。 起動できない場合、プラグインは、ユーザー インターフェイス (UI) を必要としない認証方法を理想的にサポートする必要があります。

Security Assertion Markup Language (SAML) や Azure Active Directory (AAD) 認証などの Web ベースの認証スキームをサポートすることを目的としています。

public:
 virtual ValueSet ^ ActivateForeground(Platform::String ^ packageRelativeAppId, ValueSet ^ sharedContext) = ActivateForeground;

ValueSet ActivateForeground(winrt::hstring const& packageRelativeAppId, ValueSet const& sharedContext);

public ValueSet ActivateForeground(string packageRelativeAppId, ValueSet sharedContext);

function activateForeground(packageRelativeAppId, sharedContext)

Public Function ActivateForeground (packageRelativeAppId As String, sharedContext As ValueSet) As ValueSet

パラメーター

packageRelativeAppId

String

Platform::String

winrt::hstring

起動するフォアグラウンド アプリのパッケージ相対アプリケーション識別子 (PRAID) を含む文字列。

sharedContext

ValueSet

フォアグラウンド アプリに情報を渡すために使用する ValueSet オブジェクト。 フォアグラウンド アプリは、アクティブ化イベントの引数からこれらにアクセスできます。

戻り値

ValueSet

ValueSet、フォアグラウンド アプリから VPN プラグインに渡される、選択した Windows ランタイム オブジェクトを含むオブジェクトで、フォアグラウンド要求の結果を示します。

Windows の要件

デバイス ファミリ	Windows 11 (10.0.22000.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v14.0 で導入)
アプリの機能	networkingVpnProvider

注釈

手記

VPN プラグインで IVpnPlugin.Connect メソッドの実装の外部でこの API を呼び出すと失敗します。

フォアグラウンド アクティブ化メカニズムを使用するには、複数の場所でアクティブ化を処理する必要があります。

IVpnPlugin.Connect メソッドでは、適切なパッケージ相対アプリケーション識別子 (PRAID) と、フォアグラウンド アプリに送信するすべての値を含む ValueSet を使用して、ActivateForeground を呼び出します。

フォアグラウンド アプリでは、アクティブ化をキャッチする必要があります。 フォアグラウンド アプリは、Windows.ApplicationModel.ActivationKind 値 VpnForegroundでアクティブ化されます。 アクティブ化引数は、Windows.Networking.Vpn.VpnForegroundActivatedEventArgs型になり、3 つのフィールドが含まれます。

1. ProfileName (String)。
2. SharedContext (ValueSet)。
3. ActivationOperation (Windows.Networking.Vpn.VpnForegroundActivationOperation.

フォアグラウンド アプリは、必要な承認 (または必要なデータ) を処理するようにアプリのユーザー インターフェイス (UI) を設定できます。 完了したら、ActivationOperationの Complete メソッドを呼び出し、IVpnPlugin.Connect 呼び出しに返される値の ValueSet を渡す必要があります。

IVpnPlugin.Connect 呼び出しに戻り、ActivateForeground から返された ValueSet を使用して、認証が成功したかどうかを判断し、エラーを処理します。