BASIC CHAT Functions

Check if a room exists based on a room ID.

Return Type: DataSet

Name	Type	Description
RoomID	Integer	The ID of the room you want to check.

DeleteChatRoom

Deletes a chat room.

Return Type: n/a

Name	Type	Description
ForumID	Integer	The forum which the chat belongs to.
RoomID	Integer	The ID of the room you wish to delete.

GetChatMessages

Retrieve's the latest chat messages from a room.

Return Type: DataSet

Name	Type	Description
RoomID	Integer	The ID of the room you wish to retrieve the messages from.
ChatDate	DateTime	The date which the messages will be selected from.

GetChatPeople

Retrieve's the list of people who are in the chat.

Return Type: DataSet

Name	Type	Description
RoomID	Integer	The ID of the room which you want to retrieves the people list from.
ChatDate	DateTime	The last date/time which you wish the list to be updated from.

GetChatRooms

Get all chat rooms for a forum. This function will not return the lobby.

Return Type: DataSet

Name	Type	Description
ForumID	Integer	The forum ID which you wish to retrieve the chat room for.

GetChatRoomsByID

Gets a chat room based on a room ID.

Return Type: DataSet

Name	Type	Description
RoomID	Integer	The ID of the room you wish to retrieve.
ForumID	Integer	The ID of the forum which the room belongs to.

GetChatRoomsForForum

Get all chat rooms for a forum.

Return Type: DataSet

Name	Type	Description
ForumID	Integer	The forum ID which you wish to retrieve the chat room for.

InsertChatMessage

Insert a chat message into a room.

Return Type: n/a

Name	Type	Description
Message	String	The message to be inserted.
UserID	Integer	The ID of the user who wrote the message.
RoomID	Integer	The ID of the room the message belongs to.

InsertChatRoom

Insert a new chat room in a forum.

Return Type: DataSet

Name	Type	Description
ForumID	Integer	The ID of the forum the new room belongs to.
RoomName	String	The name of the new room.

InsertUserInRoom

Insert a user in a room.

Return Type: n/a

Name	Type	Description
UserID	Integer	The ID of the user you wish to insert.
RoomID	Integer	The ID of the room you are inserting the new user in.

RemoveOldChatUsers

Removes all the users from the people list which are not active.

Return Type: n/a

Name	Type	Description
ChatDate	DateTime	All users who have not visited since this date will be removed from the room list.

UpdateChatRoom

Update a room name.

Return Type: n/a

Name	Type	Description
ForumID	Integer	The ID of the forum the room belongs to.
RoomID	Integer	The ID of the room you with to update.
RoomName	String	The name of the room you wish to update.

UpdateRoomDate

Updates the last visited date of a room.

Return Type: n/a

Name	Type	Description
UserID	Integer	The ID of the user you wish to update.
RoomID	Integer	The ID of the room the user belongs to.