Protocols/MSNP/Activities/SDK/Techref/Testing/Introduction

From NINA Wiki
Jump to navigation Jump to search


MSNP Protocol
Activity SDK
Introduction to the MSN Messenger Activity API
Key Requirements for a MSN Messenger Activity
Introduction to MSN Messenger Activity API
Overview of MSN Messenger Activity API
Activities Menu
System Requirements
Standard vs. Advanced Applications
Supported Countries and Languages
MSN Messenger Activity API Support
Copyright Information
Glossary
MSN Messenger Activity API Process
MSN Messenger Activity Process Overview
Supporting Documentation
Requesting Usage of Special Permissions
Submitting Pre-compliance Testing Results
MSN Requirements for Developing an Activity API Application
Additional Activity API Application Development Requirements
Selecting Development Options
Activity API Restrictions
Developing a MSN Messenger Activity
Development Considerations
Getting Started
Required Definitions
Document Body Basics
Single-User Application
Multiuser Application
Designing MSN Messenger Activity Graphics
Testing an Activity
Testing Overview
The Local XML File
Test Environment Setup
Increasing MSN Messenger Activity Usage
Understanding How to Increase Activity Usage with MSN
Design Considerations for Increased Activity Usage
Calling the MSN Messenger Client Directly
Calling the MSN Messenger Client from a URL
Using the MSN Messenger Variables
Technical Reference
Obtaining Access to Restricted Features
Permission Flags
ActiveX Flag
EnableIP Flag
PassportSiteID Flag
ReceiveIM Flag
ReplaceIM Flag
SendFile Flag
SendIM Flag
UserProperties Flag
The Activity Object Model
Enumerations
ConnectionType Enumeration
FileStatus Enumeration
Methods
CloseApp Method
Objects
Channel Object
Events
OnAppClose Event
OnDataError Event
OnDataReceived Event
OnFileProgress Event (Restricted)
OnFileReceived Event (Restricted)
OnIMReceived Event (Restricted)
OnRemoteAppClosed Event
OnRemoteAppLoaded Event
OnSendFileCancelled Event (Restricted)
OnTypeChanged Event
Methods
CancelSendFile Method (Restricted)
EnterIM Method (Restricted)
Initialize Method
SendData Method
SendFile Method (Restricted)
SendIM Method (Restricted)
SendIMAsUser Method (Restricted)
Properties
Data Property
Error Property
FileInfo Property (Restricted)
Type Property
IM (read-only) Property (Restricted)
IM (read-write) Property (Restricted)
Error Object
Type Property
Data Property
FileInfo Object
Path Property
Size Property
Progress Property
Incoming Property
Status Property
Messenger Object
Options Method
Phone Method
User Object
EMail Property (Restricted)
GlobalIP Property (Restricted)
LocalIP Property (Restricted)
Name Property (Restricted)
PUID Property (Restricted)
Users Collection
Item Method
_NewEnum Method
Count Property
Me Property
Inviter Property
Overview
IntroductionTermsClients
Reference
Error ListCommandsRelaying Party SuiteSpotlife
Services
XMPPHTTP GatewayTabsActivities
Documentation
Development ToolsMSNP Grid
PolygamyURLs used by MSN
Documents
Protocol Versions
Version 21
Version 18
Version 16
Version 15
Version 14
Version 13
Version 12
Version 11
Version 9
Version 8
MSNC
IntroductionP2PObject DescriptorDisplay PicturesFile Transfer
Scenarios
Microsoft Messenger for Mac
MSNP on WebTV (MSNTV)

Testing Overview

After developing an MSN® Messenger Activity, you will want to test it to be sure it behaves the way you want it to. To test your application, you must copy the file MSGRP2P.XML to the correct location. (The Local XML File topic contains an example of this file.) The file should be copied to the same directory where the MSN Messenger client executable is installed.

Note: Submission of your XML file to the MSN Messenger Support team is a requirement of the compliance process.

Copying the MSGRP2P.xmlfile on one computer is enough to test a single-user application. If the application to be tested is for more than one player, then the same file must be copied on more than one machine. One computer is used to send an invitation, and the other can receive and accept the invitation.

When Messenger starts, it checks to see whether the file MSGRP2P.xml exists and whether it contains an Acitivity entry that is in the proper format. If the entry exists and is well formed, Messenger adds a menu item called Start (Name), where (Name) is defined by the Name element in the MSGRP2P.xml file. The item is added to the Actions menu of the Messenger Conversation window. When the user selects this menu item and clicks past a warning dialog box, Messenger launches the single-user application. If the application is for multiple players, an invitation is sent to the remote user to launch the application described by the MSGRP2P.xml file.

When an invitation is received to launch the application defined by MSGRP2P.xml, the receiving instance of Messenger checks to see whether the MSGRP2P.xml file is present on the local machine. If the file is present, Messenger also checks to see whether the local file describes an application that has the same name as the one sent with the invitation.

If the MSGRP2P.xml file exists on both machines, and if the name of the application is the same in both files, the invitation can be accepted on the remote computer, and the application will be launched on both computers.

If MSGRP2P.xml is missing from the inviter's machine, the invitation will not be sent. If MSGRP2P.xml is missing from the recipient's machine, the invitation will automatically be declined. If the application name contained within the MSGRP2P.xml does not match in both instances of the XML file, the invitation will automatically be declined.

MSGRP2P.xml contains precisely the same XML that would be fetched from Messenger's Web servers if the application were published in the Activity directory, except that it uses a special ID that is reserved for testing purposes. Developers should edit the file to specify the name and URL of their application before copying the file to their test machines.