Class UserOnlineController

The UserOnlineController class provides Business Layer methods for Users Online.

Inheritance
System.Object
UserOnlineController
Namespace: DotNetNuke.Entities.Users
Assembly: DotNetNuke.dll
Syntax
public class UserOnlineController : object

Methods

| Improve this Doc View Source

ClearUserList()

Clears the cached Users Online Information.

Declaration
public void ClearUserList()
| Improve this Doc View Source

GetOnlineTimeWindow()

Gets the Online time window.

Declaration
public int GetOnlineTimeWindow()
Returns
Type Description
System.Int32

The window to use in minutes when determining if the user is online.
| Improve this Doc View Source

GetUserList()

Gets the cached Users Online Information.

Declaration
public Hashtable GetUserList()
Returns
Type Description
Hashtable

A with keys for the user ID (a GUID for anonymous users) and BaseUserInfo instances for the values.
| Improve this Doc View Source

IsEnabled()

Gets whether the Users Online functionality is enabled.

Declaration
public bool IsEnabled()
Returns
Type Description
System.Boolean

true if the Users Online functionality is enabled, otherwise false.
| Improve this Doc View Source

IsUserOnline(UserInfo)

Determines whether a User is online.

Declaration
public bool IsUserOnline(UserInfo user)
Parameters
Type Name Description
UserInfo user
Returns
Type Description
System.Boolean

true if the user is online, otherwise false.
| Improve this Doc View Source

SetUserList(Hashtable)

Sets the cached Users Online Information.

Declaration
public void SetUserList(Hashtable userList)
Parameters
Type Name Description
Hashtable userList
| Improve this Doc View Source

TrackUsers()

Tracks an online User.

Declaration
public void TrackUsers()
| Improve this Doc View Source

UpdateUsersOnline()

Update the Users Online information.

Declaration
public void UpdateUsersOnline()

Extension Methods