IChatService.SearchOnlineUsers Method

Search users who are online globally on a chat (they are performing Ping()) and meet condition (their nickname contains nickname.

Namespace: CMS.Chat
Assembly: CMS.Chat (in CMS.Chat.dll) Version: 11.0.0

Syntax

ChatGeneralResponse<IEnumerable<OnlineUserData>> SearchOnlineUsers(
	string nickname,
	int topN,
	Nullable<int> invitedToRoomID
)

Parameters

nickname

Type: System.String
Searches for users with this nickname

topN

Type: System.Int32
Returns this number of found users

invitedToRoomID

Type: System.Nullable<Int32>
If not null, only users who can be invited to this room will be returned

Return Value

Type: ChatGeneralResponse<IEnumerable<OnlineUserData>>
Online users