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

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)

Channel Object

Contains properties, methods, and events for sending and receiving data and for interacting with the MSN® Messenger Chat History window.

Members Table


Event Description
OnAppClose The MSN Messenger client is about to shut down.
OnDataError There was an unsuccessful SendData operation.
OnDataReceived Data was received from the remote application.
OnFileProgress There was some progress On a file transfer. Requires SendFile permission.
OnFileReceived A file was received from the remote applicatiOn. Requires ActiveX and SendFile permissiOns.
OnIMReceived An instant message was received from the remote application. Requires either ReceiveIM or ReplaceIM permission flag.
OnRemoteAppClosed The remote application has shut down.
OnRemoteAppLoaded The remote application has loaded and is ready to receive Events.
OnSendFileCancelled File transfer was canceled. Requires SendFile permission.
OnTypeChanged The type of connection between peers has changed.


Method Description
CancelSendFile Cancels a file transfer in progress. Requires SendFile permission.
EnterIM Enters a message into the text input window. Requires SendIM permission.
Initialize Signals the remote MSN Messenger client that the Activity is ready to accept Events.
SendData Sends data to the remote application.
SendFile Sends a file from the application. Requires SendFile and ActiveX permissions.
SendIM Sends an instant message from the application. Requires SendIM permission.
SendIMAsUser Sends an instant message as the user. Requires ReplaceIM permission.


Property Description
Data A variant containing the data received from the remote application.
Error An Error object containing data that could not be delivered.
FileInfo A FileInfo object that represents a file being sent or received. Requires SendFile permission.
Type A ConnectionType value representing the type of connection between peers.
IM (read-only) String containing the instant message that was received and displayed. Requires ReceiveIM permission.
IM (read-write) String containing the instant message that was received. The message can be changed before it is displayed. Requires ReplaceIM permission.


Object Information

Minimum Availability: MSN Messenger 6.0