ContactMessageActivatedEventArgs クラス

リファレンス

定義

名前空間:: Windows.ApplicationModel.Activation

重要

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

編集

アプリがアクティブ化され、連絡先にメッセージを送信するときにデータを提供します。

Javascript この型は、WebUIContactMessageActivatedEventArgs として表示されます。

public ref class ContactMessageActivatedEventArgs sealed : IActivatedEventArgs, IContactMessageActivatedEventArgs

/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Activation.ContactActivatedEventsContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ContactMessageActivatedEventArgs final : IActivatedEventArgs, IContactMessageActivatedEventArgs

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Activation.ContactActivatedEventsContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ContactMessageActivatedEventArgs : IActivatedEventArgs, IContactMessageActivatedEventArgs

Public NotInheritable Class ContactMessageActivatedEventArgs
Implements IActivatedEventArgs, IContactMessageActivatedEventArgs

継承: Object Platform::Object IInspectable ContactMessageActivatedEventArgs

属性: ContractVersionAttribute MarshalingBehaviorAttribute

実装: IActivatedEventArgs IContactActivatedEventArgs IContactMessageActivatedEventArgs

Windows の要件

デバイスファミリ	Windows Desktop Extension SDK (10.0.10240.0 で導入)
API contract	Windows.ApplicationModel.Activation.ContactActivatedEventsContract (v1.0 で導入)

例

PSTN 番号と Skype ID の連絡先メッセージのアクティブ化を処理するために必要なコードの例を次に示します。

protected override void OnActivated(IActivatedEventArgs args)
{
    if (args.Kind == ActivationKind.Contact)
    {
        var contactArgs = args as IContactActivatedEventArgs;
        if (contactArgs.Verb == Windows.ApplicationModel.Contacts.ContactLaunchActionVerbs.Message)
        {
            IContactMessageActivatedEventArgs messageArgs = contactArgs as IContactMessageActivatedEventArgs;

            //get contact display info
            var contactName = messageArgs.Contact.DisplayName;
            var contactThumbnail = messageArgs.Contact.Thumbnail;

            if (messageArgs.ServiceId == "telephone")
            {
                var phoneNumber = messageArgs.ServiceUserId;
                //add messaging logic for PSTN numbers
            }
            else if (messageArgs.ServiceId == "skype.com")
            {
                var userId = messageArgs.ServiceUserId;
                //add messaging logic for Skype Ids
            }
        }
    }
}

void App::OnActivated(Windows::ApplicationModel::Activation::IActivatedEventArgs const& args)
{
    if (args.Kind() == Windows::ApplicationModel::Activation::ActivationKind::Contact)
    {
        auto contactArgs{ args.as<Windows::ApplicationModel::Activation::IContactActivatedEventArgs>() };
        if (contactArgs.Verb() == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Message())
        {
            auto messageArgs{ contactArgs.as<Windows::ApplicationModel::Activation::ContactMessageActivatedEventArgs>() };

            // Get contact display info.
            auto contactName{ messageArgs.Contact().DisplayName() };
            auto contactThumbnail{ messageArgs.Contact().Thumbnail() };

            if (messageArgs.ServiceId() == L"telephone")
            {
                auto phoneNumber = messageArgs.ServiceUserId();
                // Add messaging logic for PSTN numbers.
            }
            else if (messageArgs.ServiceId() == L"skype.com")
            {
                auto userId = messageArgs.ServiceUserId();
                // Add messaging logic for Skype Ids.
            }
        }
    }
}

void App::OnActivated(IActivatedEventArgs^ args)
{
    if (args->Kind == ActivationKind::Contact)
    {
        auto contactArgs = dynamic_cast<IContactActivatedEventArgs^>(args);
        if (contactArgs->Verb == Windows::ApplicationModel::Contacts::ContactLaunchActionVerbs::Message)
        {
            auto messageArgs = dynamic_cast<ContactMessageActivatedEventArgs^>(contactArgs);

            //get contact display info
            auto contactName = messageArgs->Contact->DisplayName;
            auto contactThumbnail = messageArgs->Contact->Thumbnail;

            if (messageArgs->ServiceId == "telephone")
            {
                auto phoneNumber = messageArgs->ServiceUserId;
                //add messaging logic for PSTN numbers
            }
            else if (messageArgs->ServiceId == "skype.com")
            {
                auto userId = messageArgs->ServiceUserId;
                //add messaging logic for Skype Ids
            }
        }
    }
}

注釈

Windows 8.1を使用すると、ユーザーは連絡先カードまたは Windows Search エクスペリエンスから連絡先にメッセージを送信できます。連絡先メッセージのアクティブ化コントラクトを実装することで、Windows はアプリを起動してユーザーのメッセージを送信できます。

メッセージのアクティブ化を受信するには、アプリのマニフェストで "windows.contact" 拡張機能カテゴリに登録する必要があります。この拡張機能では、"Verb" 属性が "message" と等しい "LaunchAction" 要素を含める必要があります。その後、"ServiceId" 要素を指定して、サポートするメッセージングの種類を指定できます。たとえば、アプリで標準のテキストメッセージを処理する場合は、"電話" の "ServiceId" を指定できます。アプリが Skype などの Web ベースのサービス経由でメッセージングを処理する場合は、そのサービスのドメイン名 ("skype.com" など) を指定できます。

このコントラクトに複数のアプリが登録されている場合、ユーザーはメッセージを処理するための既定値としてそのうちの 1 つを選択できます。

マニフェスト登録の例を次に示します。

<m2:Extension Category="windows.contact" xmlns:m2="http://schemas.microsoft.com/appx/2013/manifest">
  <m2:Contact>
    <m2:ContactLaunchActions>
      <m2:LaunchAction Verb="message" DesiredView="useLess">
        <m2:ServiceId>telephone</m2:ServiceId>
      </m2:LaunchAction>
      <m2:LaunchAction Verb="message" DesiredView="useLess">
        <m2:ServiceId>skype.com</m2:ServiceId>
      </m2:LaunchAction>
    </m2:ContactLaunchActions>
  </m2:Contact>
</m2:Extension>

マニフェストに登録すると、連絡先メッセージコントラクトに対してアプリをアクティブ化できます。アプリがアクティブ化されると、イベント情報を使用してメッセージのアクティブ化を識別し、ユーザーのメッセージングシナリオを完了するのに役立つパラメーターを抽出できます。

連絡先アクションを使用してアプリのアクティブ化を処理する方法については、「クイックスタート: 連絡先アクションの処理」を参照してください。

プロパティ

Contact	メッセージの連絡先を取得します。
Kind	アクティブ化の種類を取得します。
PreviousExecutionState	アクティブ化される前のアプリの実行状態を取得します。
ServiceId	メッセージに使用されるサービスの識別子を取得します。
ServiceUserId	メッセージに使用されるサービスのユーザー識別子を取得します。
SplashScreen	スプラッシュスクリーンからアクティブ化されたアプリへの切り替えに関する情報を提供するスプラッシュスクリーンオブジェクトを取得します。
Verb	実行するアクションを取得します。

適用対象

ContactMessageActivatedEventArgs クラス

定義

Windows の要件

例

注釈

プロパティ

適用対象

こちらもご覧ください

フィードバック

フィードバック

その他のリソース