AppWidgetManager.RequestPinAppWidget メソッド

定義

名前空間:: Android.Appwidget

アセンブリ:: Mono.Android.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

現在のランチャーにアプリウィジェットをピン留めするように要求します。

[Android.Runtime.Register("requestPinAppWidget", "(Landroid/content/ComponentName;Landroid/os/Bundle;Landroid/app/PendingIntent;)Z", "GetRequestPinAppWidget_Landroid_content_ComponentName_Landroid_os_Bundle_Landroid_app_PendingIntent_Handler", ApiSince=26)]
public virtual bool RequestPinAppWidget(Android.Content.ComponentName provider, Android.OS.Bundle? extras, Android.App.PendingIntent? successCallback);

[<Android.Runtime.Register("requestPinAppWidget", "(Landroid/content/ComponentName;Landroid/os/Bundle;Landroid/app/PendingIntent;)Z", "GetRequestPinAppWidget_Landroid_content_ComponentName_Landroid_os_Bundle_Landroid_app_PendingIntent_Handler", ApiSince=26)>]
abstract member RequestPinAppWidget : Android.Content.ComponentName * Android.OS.Bundle * Android.App.PendingIntent -> bool
override this.RequestPinAppWidget : Android.Content.ComponentName * Android.OS.Bundle * Android.App.PendingIntent -> bool

パラメーター

provider: ComponentName

AppWidget のandroid.content.BroadcastReceiver BroadcastReceiver プロバイダーのComponentName。

extras: Bundle

null でない場合、これはランチャーアプリに渡されます。たとえば、 #EXTRA_APPWIDGET_PREVIEW はカスタムプレビューに使用できます。

successCallback: PendingIntent

null でない場合、この意図はウィジェットの作成時に送信されます。

返品

Boolean

TRUE ランチャーがこの機能をサポートしている場合は。 API はユーザーの応答を待たずに戻ることに注意してください。そのため、この API から TRUE を取得しても、ショートカットがピン留めされている わけではありません 。 FALSE ランチャーがこの機能をサポートしていない場合、または呼び出し元アプリがホーム画面で制限されたアイテムを持つユーザープロファイルに属している場合。

属性: RegisterAttribute

注釈

現在のランチャーにアプリウィジェットをピン留めするように要求します。この要求を受け入れるのはランチャー次第です (必要に応じてユーザーの確認が表示されます)。要求が受け入れられた場合、呼び出し元は追加の #EXTRA_APPWIDGET_IDで確認を受け取ります。

ユーザーが要求を拒否した場合、呼び出し元アプリは応答を受け取りません。

フォアグラウンドアクティビティまたはフォアグラウンドサービスを持つアプリのみが呼び出すことができます。それ以外の場合は、 IllegalStateExceptionがスローされます。

同じパッケージがこの API を複数回連続して呼び出す場合に、以前の保留中の要求を処理する方法はランチャー次第です。たとえば、前の要求は無視される場合があります。

この場合、ランチャーにはプロバイダーに関連付けられている構成アクティビティは表示されません。アプリは、コールバックへの応答として構成アクティビティを表示するか、API を呼び出す前に表示することができます (widgetId が認識される前に保持されないように、さまざまな構成を successCallback にカプセル化できます)。

Javaドキュメント。

このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。

適用対象