User

Sansar.Simulation.User

User Class

The User class handles interactions user logins and logoffs.

Syntax

[Sansar.Script.Interface]
public class User : Sansar.Script.InstanceInterface

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Members

See Also: Inherited members from Sansar.Script.InstanceInterface.

Public Fields

static readonly
AddUser string . For subscribing to events for users entering the scene
static readonly
RemoveUser string . For subscribing to events for users leaving the scene

Public Properties

[read-only]
 
IsValid bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.)

Public Methods

  Subscribe (string, User.SubscriptionHandler, bool)
Subscribes to User Events.
  Subscribe (string, Sansar.Script.SessionId, User.SubscriptionHandler, bool)
Subscribes to User Events.
  Subscribe (string, Sansar.Script.SessionId, Action<UserData>, bool)
Subscribes to User Events.

Member Details

AddUser Field

For subscribing to events for users entering the scene

Syntax

public static readonly string AddUser

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

RemoveUser Field

For subscribing to events for users leaving the scene

Syntax

public static readonly string RemoveUser

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Subscribe Method

Subscribes to User Events.

Syntax

[Sansar.Script.Interface]
public void Subscribe (string Action, User.SubscriptionHandler callback, bool persistent)

Parameters

Action
string action of the event: AddUser, RemoveUser, NameChange
callback
Callback which is executed when the event completes.
persistent
Optional, set to false to unsubscribe after one event.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Subscribe Method

Subscribes to User Events.

Syntax

[Sansar.Script.Interface]
public void Subscribe (string Action, Sansar.Script.SessionId User, User.SubscriptionHandler callback, bool persistent)

Parameters

Action
string action of the event: AddUser, RemoveUser, NameChange
User
Sansar.Script.SessionId for the user.
callback
Callback which is executed when the event completes.
persistent
Optional, set to false to unsubscribe after one event.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Subscribe Method

Subscribes to User Events.

Syntax

[Sansar.Script.Interface]
public void Subscribe (string Action, Sansar.Script.SessionId User, Action<UserData> callback, bool persistent)

Parameters

Action
string action of the event: AddUser, RemoveUser, NameChange
User
Sansar.Script.SessionId for the user.
callback
Callback which is executed when the event completes.
persistent
Optional, set to false to unsubscribe after one event.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.