 | User Class |
Represents a user or client (either local or remote) that connected and in the current session
Inheritance HierarchySystemObject
ImmerseSDK.SessionsUser
ImmerseSDK.SessionsUser
Namespace: ImmerseSDK.Sessions
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
SyntaxC#
public sealed class User
The User type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | User |
Constructs a new user object. This is used by the serialisation code.
|
| User(Int32, String, String) |
Creates a new user object
|
| User(Int32, String, UserClientTypes, UserProfileType) |
Creates a new user object
|
Properties| Name | Description | |
|---|---|---|
 | ClientType |
Type of user or client, strongly typed to an enum value
|
| ID |
The unique ID of this user
|
| Profile |
Profile type, used to identify user privilages within Unity
|
| RawClientType |
Type of user or client
|
| RawProfile |
Profile level, used to identify user privilages on the platform
|
Methods| Name | Description | |
|---|---|---|
| Equals |
Compares against object using Id
(Overrides ObjectEquals(Object).) |
 | Find |
Gets a reference to the user object for the given id
|
| FindLocal |
Gets a reference to the local user object
|
| GetHashCode |
HashCode generated from the User ID only
(Overrides ObjectGetHashCode.) |
| HasAllPrivilages |
Checks if this user has all of the given privilages
|
| HasAnyPrivilages |
Checks if this user has any of the given privilages
|
| HasPrivilage |
Checks if this user has the given privilage
|
| HasSpaceOwnerPrivilages | Obsolete.
Returns true if the user is the owner of the current space, or has been granted facilitator privilages for that space
|
| IsLocal |
True if this user is local
|
| ToString |
Helps in debugging and console output. PRints the current user's name, whether they are online, and if they are local or remote.
(Overrides ObjectToString.) |
Operators| Name | Description | |
|---|---|---|
 | Equality |
Equals(a, b)
|
| (User to UserID) |
Converts a User object to a UserId
|
| Inequality |
!Equals(a, b)
|
Fields| Name | Description | |
|---|---|---|
 | ArchwayID |
The Archway id. Used to identify the user on the server
|
| AudioTags |
List of audio tags currently associated with this user
|
| ConnectionTypes |
Identifies the connection type
|
| Name |
The display name for this user, as it is seen by others
|
| RawID |
The Ghost id. Used to identify the user on the network
|
| RoleId |
Assigned role id, where 0 is not assigned
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetGroup |
Returns the user's current group
(Defined by UserExtensions.) |
| HasConnectionType |
Returns true if the user has the specified connection type
(Defined by UserExtensions.) |
See Also