Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Objects/Channel/Properties/IM: Difference between revisions
Jump to navigation
Jump to search
Animadoria (talk | contribs) (Created automatically by Anima Importer) |
Animadoria (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
<!-- Generated @ 08/12/2022 23:46:01 +01:00 using Anima's CHM converter based on techref/objectmodel/objects/channel/properties/IM.htm --> | <!-- Generated @ 08/12/2022 23:46:01 +01:00 using Anima's CHM converter based on techref/objectmodel/objects/channel/properties/IM.htm --> | ||
{{Protocols/MSNP|section=Activities}} | {{Protocols/MSNP|section=Activities}} | ||
__NOTOC__= | __NOTOC__= [[Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Objects/Channel/Index|Channel]].IM (read-write) Property (Restricted) = | ||
This property returns a string containing the instant message that has been received. It contains new data whenever the <span class="clsEvent">OnIMReceived</span> event fires. With ReplaceIM permission, the string can be changed during the <span class="clsEvent">OnIMReceived</span> event, before it is displayed. This property is labeled "restricted" because it is only available if the application has the ReplaceIM permission. For more information, see [[Protocols/MSNP/Activities/SDK/Sandbox|Standard vs. Advanced Applications]]. | This property returns a string containing the instant message that has been received. It contains new data whenever the <span class="clsEvent">OnIMReceived</span> event fires. With ReplaceIM permission, the string can be changed during the <span class="clsEvent">OnIMReceived</span> event, before it is displayed. This property is labeled "restricted" because it is only available if the application has the ReplaceIM permission. For more information, see [[Protocols/MSNP/Activities/SDK/Sandbox|Standard vs. Advanced Applications]]. | ||
VBScript Syntax | === VBScript Syntax === | ||
<div class="clsCodeIndent"> | <div class="clsCodeIndent"> | ||
| Line 13: | Line 13: | ||
</div> | </div> | ||
JavaScript Syntax | === JavaScript Syntax === | ||
<div class="clsCodeIndent"> | <div class="clsCodeIndent"> | ||
| Line 20: | Line 20: | ||
</div> | </div> | ||
Property Value | === Property Value === | ||
A string object containing the instant message received from the remote Messenger client. | A string object containing the instant message received from the remote Messenger client. | ||
Example | === Example === | ||
This example illustrates the translation of an instant message. | This example illustrates the translation of an instant message. | ||
| Line 47: | Line 47: | ||
</div> | </div> | ||
Remarks | === Remarks === | ||
This property contains data that should be inspected every time the <span class="clsEvent">OnIMReceived</span> event occurs. | This property contains data that should be inspected every time the <span class="clsEvent">OnIMReceived</span> event occurs. | ||
Changes must be made to Channel.IM before the <span class="clsEvent">OnIMReceived</span> event is finished to be displayed in the Chat History window. | Changes must be made to Channel.IM before the <span class="clsEvent">OnIMReceived</span> event is finished to be displayed in the Chat History window. | ||
Latest revision as of 01:46, 13 August 2022
Channel.IM (read-write) Property (Restricted)
This property returns a string containing the instant message that has been received. It contains new data whenever the OnIMReceived event fires. With ReplaceIM permission, the string can be changed during the OnIMReceived event, before it is displayed. This property is labeled "restricted" because it is only available if the application has the ReplaceIM permission. For more information, see Standard vs. Advanced Applications.
VBScript Syntax
external.Channel.IM
JavaScript Syntax
window.external.Channel.IM
Property Value
A string object containing the instant message received from the remote Messenger client.
Example
This example illustrates the translation of an instant message.
// Changing an IM before it is displayed requires ReplaceIM permission flag.
var myChannel = window.external.Channel;
function Translate(mySourceText) {
// define translation function here
}
function Channel_OnIMReceived() {
var translated;
translated = Translate( myChannel.IM );
myChannel.IM = translated;
}
Remarks
This property contains data that should be inspected every time the OnIMReceived event occurs.
Changes must be made to Channel.IM before the OnIMReceived event is finished to be displayed in the Chat History window.