diff --git a/api.md b/api.md index e6915d0..fa1aab9 100644 --- a/api.md +++ b/api.md @@ -68,13 +68,15 @@ Requires `ReplaceIM` permission. Unimplemented. Send a message (`bstrIM`) as if written by the user through the channel. -### window.external.Channel.SendFile(pdFileInfo: FileInfo) +### window.external.Channel.SendFile(pdFileInfo: FileInfo*) Requires `SendFile` and `ActiveX` permissions. +Returns the `pdFileInfo` object. + Unimplemented. Send a file from the local client's storage device through the Channel. -### window.external.Channel.CancelSendFile(aFileInfo: FileInfo) +### window.external.Channel.CancelSendFile(aFileInfo: FileInfo*) Requires `SendFile` and `ActiveX` permissions. @@ -92,6 +94,8 @@ Technical: Called by a beforeunload handler in messenger.js. ### Channel_OnDataError +Accepts parameter `pdispError`: {"Type": long, "Data": string}. + Triggered if a `window.external.Channel.SendData()` were to fail on the local client. The local client should handle the Error object in `window.external.Error`: @@ -101,22 +105,30 @@ The local client should handle the Error object in `window.external.Error`: ### Channel_OnDataReceived +Accepts parameter `vData`: string. + Triggered after the remote client calls `window.external.Channel.SendData()`. The local client should handle the data given in `window.external.Channel.Data` as a string. ### Channel_OnFileProgress +Accepts parameter `pdispFile`: FileInfo. + Unimplemented. Only fired if Activity has `SendFile` permission. Triggered after data has been sent over the channel to the remote client regarding a file transfer. ### Channel_OnFileReceived +Accepts parameter `pdispFile`: FileInfo. + Unimplemented. Only fired if Activity has `SendFile` permission. Triggered after a file transfer to the local client is received. +The local client should handle the data given in `window.external.Channel.File` as a FileInfo. + ### Channel_OnIMReceived Unimplemented. Only fired if Activity has `ReceiveIM` permission. @@ -139,15 +151,19 @@ Triggered when the remote client's Activity window has fired `window.external.Ch ### Channel_OnSendFileCancelled +Accepts parameter `pdispFile`: FileInfo. + Unimplemented. Only fired if Activity has `SendFile` permission. Triggered when a file transfer is cancelled by either client. ### Channel_OnTypeChanged +Accepts parameter `eConnectionType`: number. + Triggered when the connection type changes. -The local client can see the new connection type by getting `window.external.Channel.Type`, which provides these values: +The local client can see the new connection type by getting `window.external.Channel.Type` (or `eConnectionType`'s value), which provides these values: 0: Direct connection, Switchboard connection exists, but the local client has a direct connection to the remote client. @@ -155,6 +171,13 @@ The local client can see the new connection type by getting `window.external.Cha 2: Disconnected, No connection to the remote client. +### Channel_OnIMSent + +Accepts parameter `bstrIM`: string. + +Unimplemented. Triggered when the local client has sent an Instant Message. The `bstrIM` parameter contains the IM text. + +Originally introduced in client version 6.2. # Other objects