IMsnNotification::put_ActionURL プロパティ
.jpg)
ActionURL プロパティの値を設定します。ActionURL は、この通知のアクション用 URL を指定する Unicode 文字列のプロパティです。アクション用 URL は、Microsoft® .NET Alerts プロバイダのサイト上の Web ページへのパスを示します。通知の受信者は、この Web ページで通知の詳細を確認することができます。このパスは、SiteURL プロパティで指定した URL を基準にしている必要があります。このプロパティは必須です。
構文
HRESULT put_ActionURL(
BSTR newVal
);
パラメータ
- newVal
[入力] Unicode 文字列。アクション用 URL が含まれます。newVal を NULL に設定してこのメソッドを呼び出すと、ActionURL プロパティがクリアされます。
戻り値
| S_OK | 呼び出しが正常に行われたか、newVal が NULL です。 |
| E_OUTOFMEMORY | プロパティに必要なメモリを割り当てようとしているときにエラーが発生しました。 |
解説
重要 アクション用 URL にはカスタムの Query String パラメータを含めることができますが、ユーザーに関する個人情報 (ユーザー名、電話番号など) は埋め込まないようにしてください。 アクション用 URL はセキュリティ保護や暗号化が行われないため、個人情報の伝達には適していません。
次の図は、通知のポップアップ メッセージにアクション用 URL リンクが表示される場所を示しています。
.png)
このプロパティに指定できる最大文字数は 100 文字です。長さの制限は、.NET Alerts クライアント ライブラリではなく、.NET Alerts ルーティング エンジンによって適用されます。長さの制限を超えてもクライアント ライブラリは警告やエラーを出しませんが、ルーティング エンジンによって通知が拒否されます。
.NET Alerts ルーティング エンジンによって通知が処理されると、ActionURL、BodyIcon、および SubscribeURL の各プロパティで指定した相対 URL が、SiteURL プロパティで指定した基本サイト URL に追加されます。サイト URL と相対 URL は、結合されて正しい形式の URL になるように指定してください。サイト URL の末尾にスラッシュ ("/") を付けるか、相対 URL の先頭にスラッシュを付けますが、両方付ける必要はありません。
このプロパティは、XML でエンコードされている必要があります。XML エンコードの問題は、通知が米国 MSN® Mobile に登録されたデバイスに配信されない一般的な原因の 1 つです。次の表に、エンコードが必要な文字を示します。
| 文字 | エンコード |
|---|---|
| < | < |
| > | > |
| & | & |
| " | " |
| ' | ' |
たとえば、次のアクション用 URL にはアンパサンドが含まれており、この文字は XML でエンコードしなければなりません。
/action.aspx?param1=data1¶m2=data2
ActionURL プロパティの場合、この URL は次のように指定する必要があります。
/action.aspx?param1=data1&param2=data2
.NET Alerts ルーティング エンジンが通知を処理すると、次のパラメータがアクション用 URL に追加されます。
| パラメータ | 説明 |
|---|---|
| to_pid | ToPID プロパティの値。 |
| notification_id | ID プロパティの値。 |
| message_id | MessageID プロパティの値。現時点では、このパラメータの値は常にゼロです。 |
| agent | 通知の配信先のエージェントを示す文字列。"messenger" という値は、アクション用 URL が通知のポップアップ メッセージから呼び出されたことを示します。通知が電子メール アドレスや最近受信した通知の一覧に配信された場合は、アクション用 URL にこのパラメータは追加されません。 |
受信者がアクション用 URL をポップアップ メッセージから呼び出したかどうかを判断するには、アクション用 URL に "agent=messenger" が存在するかどうかを確認します。たとえば、次のプロパティが指定されている通知を見てみましょう。
| 通知のプロパティ | 値 |
|---|---|
| SiteURL | http://www.adventure-works |
| ActionURL | /action.aspx?my-parameter=qwerty |
| ToPID | 0x01234567:0x89ABCDEF |
| ID | 256 |
| MessageID | 0 |
Messenger ポップアップ メッセージに対して生成された URL は次のようになります。
http://www.adventure-works/action.aspx?my-parameter=qwerty&to;_pid=0x01234567:0x8ABCDEF¬ification_id=256&message;_id=0&agent;=messenger
電子メールの通知に対して生成された URL は次のようになります。
http://www.adventure-works/action.aspx?my-parameter=qwerty&to;_pid=0x01234567:0x8ABCDEF¬ification_id=256&message;_id=0
最近受信した通知の一覧の通知に対して生成された URL は次のようになります。
http://www.adventure-works/action.aspx?my-parameter=qwerty&to;_pid=0x01234567:0x8ABCDEF&message;_id=0¬ification_id=256
関連項目
C++ リファレンスの概要 | IMsnNotification::get_ActionURL プロパティ | IMsnNotification::put_SiteURL プロパティ
|