Protocols/MSNP/Activities/SDK/Techref/Promo/Variables

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)

Using the MSN Messenger Variables

After an Activity has been added to the Activity directory in MSN®, your application can be started from either the Games or Activities button on the MSN Messenger toolbar.

If you want, you can increase usage of your Activity by directing users to your Activity directly from a Web page. You can accomplish this in either of two ways: by adding script to a Web page that calls an ActiveX® control directly, or by adding a URL link to a Web page. This URL directs the user's browser to a Web site that the MSN Messenger team controls. For more information about directly starting your Activity through the ActiveX control, see Calling the MSN Messenger Client Directly. For more information about using a URL to start your Activity, see Calling the MSN Messenger Client from a URL.

You can use either of the preceding two methods; however, coding a Web site to control the MSN Messenger client directly is the preferred method because this functionality is built into the client, and the URL that this method uses may change in the future.

In order to take the user directly to your Activity, you need to supply the following two string parameters:

  • AppID
  • BOT


The AppID variable is a composite of two values: the number that corresponds to your desired market or country (for example, 5129 represents New Zealand) and the number that the MSN Support team assigned to your application in the Activity directory (for example, 126). In this case, the AppID value for your Activity for the New Zealand market would be 5129126.

The BOT variable must be in the following format: someone@example.com.

The two variables, AppID and BOT, are optional, and you can alter the behavior of the called MSN Messenger client by choosing to eliminate either of these two variables. The following table illustrates the behavior observed when either of these two optional variables is passed to the MSN Messenger client (by either method):

AppID variable passed to client? BOT variable passed to client? Observed client behavior
No No The user will be:
  1. Presented with the User list from which the user can choose a friend to engage in a game or activity.
  2. Presented with the Conversation window, from which the user can select which game or activity to share with the other user.
  3. Offered the opportunity to select the desired game or activity with the other user.
Yes No The user will be:
  1. Presented with the User list from which the user can choose a friend to engage in a game or activity.
  2. Presented with an invitation (after the Conversation window opens) for the application specified by the AppID variable.
  3. Offered the opportunity to enjoy the game or activity with the other user (if the other user chose to play the game or participate in the activity).
No Yes The user will be:
  1. Brought into the Conversation window with another user whose e-mail address was specified by the BOT parameter.
  2. Presented with the Conversation window, from which the user can select which game or activity to share with the other user.
  3. Offered the opportunity to select the desired game or activity with the other user.
Yes Yes The user will be:
  1. Brought into the conversation window with another user whose e-mail address was specified by the BOT parameter.
  2. Presented with an invitation (after the Conversation window opens) for the application specified by the AppID variable.
  3. Offered the opportunity to enjoy the game or activity with the other user (if the other user chose to play the game or participate in the activity).