Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Index

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

Introduction • Terms • Clients

Reference

Error List • Commands • Relying Party Suite • Spotlife

Services

XMPP • HTTP Gateway • Tabs • Activities

Documentation

Development Tools • MSNP Grid

Polygamy • URLs 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

Introduction • P2P • Object Descriptor • Display Pictures • File Transfer

Scenarios

Microsoft Messenger for Mac

MSNP on WebTV (MSNTV)

The Activity Object Model

The MSN® Messenger Activity object model contains a set of data transfer methods, as well as connection-oriented events and properties.

No methods are provided for opening or closing a connection, because the underlying connection is provided by MSN Messenger.

This chapter contains the following topics:

• Enumerations
• Objects
• Methods