Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Objects/Channel/Methods/SendFile

From NINA Wiki
Revision as of 22:43, 12 August 2022 by Animadoria (talk | contribs) (Created automatically by Anima Importer)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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)

<a class="clsStd" href="/techref/objectmodel/objects/channel/index.htm">Channel</a>.SendFile Method (Restricted)

This method transfers a file to the remote application. The method takes a FileInfo object created through an ActiveX® control. The ActiveX control must provide the user an interface to browse and select a file to transfer. It is the responsibility of the developer to provide this ActiveX control. The method is labeled "restricted" because it is only available if the application has the ActiveX and SendFile permission flags. For more information, see [[Protocols/MSNP/Activities/SDK/../../../../../Sandbox|Standard vs. Advanced Applications]].

VBScript Syntax

set myChannel = external.Channel

' An ActiveX control is required to access a local file
set myFileWrapper = myActiveX.getfile(myFileName)

sub cmdSendFileButton_OnClick
    On Error Goto Handler
    myFileTracker = myChannel.SendFile(myFileWrapper)
    ' myFileTracker is now a FileInfo object
    Exit Sub

:Handler
    Document.Write("SendFile failed. Error Description: " & err.description)
End Sub
                    

JavaScript Syntax

myChannel = window.external.Channel;

function cmdSendFileButton_OnClick() {
// An ActiveX control is required to access the local file
    try {
        var myFileWrapper = myActiveX.getfile();
        myFileTracker = myChannel.SendFile(myFileWrapper);
        // myFileTracker is now a FileInfo object
    }
    catch(ex) {
    document.write("SendFile failed. Error Description: " + ex.description);
    }
}
                    

Parameters

pdFileInfo
A FileInfo object that contains the path to the file to be sent.

Return Values

Returns a FileInfo object that contains the properties of the file transfer.

Remarks

An exception is thrown if the application does not have both the ActiveX and SendFile permissions, or if the parameter does not correspond to a valid file object.