ChatMessageNotificationTriggerDetails クラス

定義

名前空間:

Windows.ApplicationModel.Chat

登録済みのバックグラウンド タスクからトリガーされるメッセージ通知を表します。 チャット アプリは、タスク トリガーとタスク エントリ ポイントを設定することで、受信メッセージの通知を受信したり、イベントを送信したりできます。

public ref class ChatMessageNotificationTriggerDetails sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ChatMessageNotificationTriggerDetails final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ChatMessageNotificationTriggerDetails

Public NotInheritable Class ChatMessageNotificationTriggerDetails

継承

Object Platform::Object IInspectable ChatMessageNotificationTriggerDetails

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

デバイス ファミリ	Windows 10 (10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)
アプリの機能	chat chatSystem smsSend

注釈

チャット アプリは、受信メッセージの既定のハンドラーとして機能するために、通知を処理するバックグラウンド タスクを登録する必要があります。 バックグラウンド タスクを登録するには、 Package.appxmanifest ファイルにバックグラウンド タスク拡張子が含まれている必要があります。 次のコード スニペットを 要素に Application/Extensions 追加します。

<Extension Category="windows.backgroundTasks" Entry-Point="Tasks.ExampleBackgroundTask">
    <BackgroundTasks>
        <Task Type="chatMessageNotification"/>
        <Task Type="systemEvent"/>
    </BackgroundTasks>
</Extension>

バックグラウンド タスクの Run メソッドは、通知トリガーの詳細を含むタスク インスタンスを受け取ります。 TriggerDetails プロパティは、ChatMessageNotificationTriggerDetails オブジェクトにキャストされます。 チャット メッセージのトリガーの詳細は、次の例に示すように取得されます。

public void Run(IBackgroundTaskInstance taskInstance)
{
    BackgroundTaskDeferral deferral = taskInstance.GetDeferral();
    ChatMessageNotificationTriggerDetails triggerDetails =
        (ChatMessageNotificationTriggerDetails) taskInstance.TriggerDetails;

    if (triggerDetails != null)
    {
        SendToast(triggerDetails.ChatMessage);
    }
}

プロパティ

ChatMessage	通知に関連付けられているメッセージを取得します。 これは、受信メッセージまたは送信状態イベントを含む送信メッセージです。
ShouldDisplayToast	バックグラウンド タスクがメッセージのトースト通知を発行する必要があるかどうかを示すブール値を取得します。
ShouldUpdateActionCenter	メッセージで Windows アクション センターを更新する必要があるかどうかを示すブール値を取得します。
ShouldUpdateBadge	バックグラウンド タスクがアプリのロック画面数を更新する必要があるかどうかを示すブール値を取得します。
ShouldUpdateDetailText	バックグラウンド タスクがメッセージのアプリのタイル数を更新する必要があることを示すブール値を取得します。