HoloToolkit.Sharing.SessionUsersTracker Class Reference

Keeps track of the users in the current session. Instance is created by Sharing Stage when a connection is found. More...

Inheritance diagram for HoloToolkit.Sharing.SessionUsersTracker:

Public Member Functions
	SessionUsersTracker (ServerSessionsTracker sessionsTracker)
User	GetUserById (int userId)
	Finds and returns an object representing a user who has the supplied id number. Returns null if the user is not found. More...
void	Dispose ()

Protected Member Functions
virtual void	Dispose (bool disposing)

Properties
List< User >	CurrentUsers [get]
	List of users that are in the current session. More...

Events
Action< User >	UserJoined
	UserJoined event notifies when a user joins the current session. More...
Action< User >	UserLeft
	UserLeft event notifies when a user leaves the current session. More...

Detailed Description

Keeps track of the users in the current session. Instance is created by Sharing Stage when a connection is found.

Definition at line 14 of file SessionUsersTracker.cs.

Constructor & Destructor Documentation

SessionUsersTracker()

HoloToolkit.Sharing.SessionUsersTracker.SessionUsersTracker

(

ServerSessionsTracker

sessionsTracker

)

Definition at line 36 of file SessionUsersTracker.cs.

Member Function Documentation

Dispose() [1/2]

void HoloToolkit.Sharing.SessionUsersTracker.Dispose

(

)

Definition at line 68 of file SessionUsersTracker.cs.

Dispose() [2/2]

virtual void HoloToolkit.Sharing.SessionUsersTracker.Dispose ( bool  disposing )

protectedvirtual

Definition at line 74 of file SessionUsersTracker.cs.

GetUserById()

User HoloToolkit.Sharing.SessionUsersTracker.GetUserById

(

int

userId

)

Finds and returns an object representing a user who has the supplied id number. Returns null if the user is not found.

Parameters

userId

The numerical id of the session User to find

Returns

The User with the specified id or null (if not found)

Definition at line 53 of file SessionUsersTracker.cs.

Property Documentation

CurrentUsers

List<User> HoloToolkit.Sharing.SessionUsersTracker.CurrentUsers

get

List of users that are in the current session.

Definition at line 34 of file SessionUsersTracker.cs.

Event Documentation

UserJoined

Action<User> HoloToolkit.Sharing.SessionUsersTracker.UserJoined

UserJoined event notifies when a user joins the current session.

Definition at line 19 of file SessionUsersTracker.cs.

UserLeft

Action<User> HoloToolkit.Sharing.SessionUsersTracker.UserLeft

UserLeft event notifies when a user leaves the current session.

Definition at line 24 of file SessionUsersTracker.cs.

---

The documentation for this class was generated from the following file:

• Assets/HoloToolkit/Sharing/Scripts/SessionUsersTracker.cs