Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Objects/Users/Properties/Inviter: Difference between revisions

From NINA Wiki
Jump to navigation Jump to search
(Created automatically by Anima Importer)
No edit summary
 
Line 1: Line 1:
<!-- Generated @ 08/12/2022 23:46:12 +01:00 using Anima's CHM converter based on techref/objectmodel/objects/users/properties/Inviter.htm -->
<!-- Generated @ 08/12/2022 23:46:12 +01:00 using Anima's CHM converter based on techref/objectmodel/objects/users/properties/Inviter.htm -->
{{Protocols/MSNP|section=Activities}}
{{Protocols/MSNP|section=Activities}}
__NOTOC__= <a class="clsStd" href="/techref/objectmodel/objects/users/index.htm">Users</a>.Inviter Property =  
__NOTOC__= [[Protocols/MSNP/Activities/SDK/Techref/Objectmodel/Objects/Users/Index|Users]].Inviter Property =  




Returns a <span class="clsUIElement">User</span> object that identifies the user who started an MSN® Messenger chat instance. This property is read-only.
Returns a <span class="clsUIElement">User</span> object that identifies the user who started an MSN® Messenger chat instance. This property is read-only.


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 ===


This property identifies the user who originally began this Messenger conversation.
This property identifies the user who originally began this Messenger conversation.


Example
=== Example ===


To determine whether the local user initiated this conversation, test for the equivalency of <span class="clsMethod">Users.Inviter</span> and <span class="clsMethod">Users.Me</span>.
To determine whether the local user initiated this conversation, test for the equivalency of <span class="clsMethod">Users.Inviter</span> and <span class="clsMethod">Users.Me</span>.
Line 41: Line 41:
}
}
&lt;/script&gt;
&lt;/script&gt;
//--&gt;
//--&gt;</pre>
                </pre>


</div>
</div>
Remarks
=== Remarks ===


Test for equivalence between <span class="clsMethod">Users.Me</span> and <span class="clsMethod">Users.Inviter</span> to see if the local user initiated the conversation. In JavaScript, the equivalence operator is three equal signs (===).
Test for equivalence between <span class="clsMethod">Users.Me</span> and <span class="clsMethod">Users.Inviter</span> to see if the local user initiated the conversation. In JavaScript, the equivalence operator is three equal signs (===).


Displaying the inviter's name is implicitly restricted because the <span class="clsProperty">Name</span> property of the <span class="clsObject">User</span> object needs the <span class="clsUIElement">PassportSiteID</span> permission flag.
Displaying the inviter's name is implicitly restricted because the <span class="clsProperty">Name</span> property of the <span class="clsObject">User</span> object needs the <span class="clsUIElement">PassportSiteID</span> permission flag.

Latest revision as of 02:17, 13 August 2022


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 ListCommandsRelying 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
Version 2
MSNC
IntroductionP2PObject DescriptorDisplay PicturesFile Transfer
Scenarios
Microsoft Messenger for Mac
MSNP on WebTV (MSNTV)

Users.Inviter Property

Returns a User object that identifies the user who started an MSN® Messenger chat instance. This property is read-only.

VBScript Syntax

external.Users.Inviter

JavaScript Syntax

window.external.Users.Inviter;

Property Value

This property identifies the user who originally began this Messenger conversation.

Example

To determine whether the local user initiated this conversation, test for the equivalency of Users.Inviter and Users.Me.

<script type="text/javascript">
<!--
if (window.external.users.inviter === window.external.users.me) {
    // I invited another user to this conversation.
    document.write("I am the Inviter.");
}
else {
    // I am the user who accepted the invitation.
    document.write("I am not the Inviter.");
}
</script>
//-->

Remarks

Test for equivalence between Users.Me and Users.Inviter to see if the local user initiated the conversation. In JavaScript, the equivalence operator is three equal signs (===).

Displaying the inviter's name is implicitly restricted because the Name property of the User object needs the PassportSiteID permission flag.