Protocols/MSNP/Activities/SDK/Samples/SampleSetup

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 ListCommandsRelying 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
Version 2
MSNC
IntroductionP2PObject DescriptorDisplay PicturesFile Transfer
Scenarios
Microsoft Messenger for Mac
MSNP on WebTV (MSNTV)

Test Environment Setup

To set up a test environment, you will need:

  • Your MSN® Messenger Activity for testing. An application consists of an HTML file and any associated files, such as images, style sheets, scripts, or ActiveX® controls.
  • A Web server. For testing purposes, any type of Web server will work. The only requirement is that the application be accessible with an HTTP request.
  • For single-user applications, one computer to run the Messenger client. It can be the same computer that is running the Web server.
  • For multiuser applications, two computers are required to run Messenger, because only one client per computer can sign in at a time.

In the following example, the sample application, Tictactoe.htm, is tested.

  1. Copy the application files to the Web server. In this example, the server name is ls_test_server, and the files are in a Web directory called 3t. The Web structure of the files looks like this:
  2. Customize the configuration file called MSGRP2P.xml, as described in the topic The Local XML File. Open the XML file and find the element URL. This element specifies the address from which the application can be loaded.
  3. Copy the file MSGRP2P.xml to the program directory where MSN Messenger is installed. Typically, this directory is C:\Program Files\MSN Messenger\. The next time Messenger opens a Conversation window, it checks for the existence of the XML file. If it exists and contains valid information, a menu item is added to the Actions menu of the Conversation window. The menu item is called Run (Name) where (Name) is the contents of the Name element in MSGRP2P.xml.
  4. Tictactoe.htm is a multiuser application, so two computers must be set up to test it. Both computers must have a copy of MSGRP2P.xml in the Messenger program directory.
  5. Sign in to Messenger on both test computers.
  6. From one computer, send an instant message to the contact that is signed in on the other computer.
  7. On the other computer, click the instant message. A Conversation window is open on both computers.
  8. On the Actions menu of either computer, click Run Tic Tac Toe to send an invitation.
  9. On the other computer, accept the invitation.
  10. Both computers display Messenger Conversation windows running Tic Tac Toe in the Activity Window.


If the menu item, Run Tic Tac Toe does not appear on the Actions menu, Messenger could not load the MSGRP2P.xml file. Verify that the file is in the correct directory and that it contains valid XML.

If either computer displays the Activity window but does not load the application, the URL specified in the MSGRP2P.xml file may not be valid. Verify that the URL is valid and reachable by the computer.

Activities use event handlers and methods that are only available in the Launch Site environment. If you double-click an Activity file and its HTML file association causes it to display in an Internet browser, the browser may show scripting errors.

Only one Activity can be tested at a time. To test another application, change the URL and Name elements in the MSGRP2P.xml file on both computers to correspond to the new application.