ChatService.Ping Method

Keeps user online in global list of chat online users (this method needs to be called periodically). Checks if there were any changes in: - rooms (new room added, changed name, etc.) since lastRoomsChange. - counts of users in rooms since lastUsersInRoomsChange. - global online users since lastOnlineUsersChange. - notifications for online user since lastNotificationChange. If any of this objects has changed, changes are send back to client. If any of params is null, its objects are not checked. If param is 0, it is the first request and all objects are returned. If user is not online on chat, only CurrentChatUserState will be returned and data (rooms, online users, etc.) will be null.

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

Syntax

public ChatGeneralResponse<PingResultData> Ping(
	Nullable<long> lastRoomsChange,
	Nullable<long> lastUsersInRoomsChange,
	Nullable<long> lastOnlineUsersChange,
	Nullable<long> lastNotificationChange
)

Parameters

lastRoomsChange

Type: System.Nullable<Int64>
Time of last check for rooms list made by this client.

lastUsersInRoomsChange

Type: System.Nullable<Int64>
Time of last check for counts of users in rooms made by this client.

lastOnlineUsersChange

Type: System.Nullable<Int64>
Time of last check for global online users made by this client.

lastNotificationChange

Type: System.Nullable<Int64>
Time of last check for notifications made by this client.

Return Value

Type: ChatGeneralResponse<PingResultData>
PingRoomsResultData

Implements

IChatService.Ping(Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>)