get_online_users

Function

Function Name	Description	Level
get_online_users	Returns a list of user who are currently online. You can specify forum and thread to limit the users you need.	3,4

Input Parameters:

Name	Type	Required?	Description	Level
page	Int			4
perpage	Int			4
id	String		return a list of online users who are currently viewing this sub-forum or thread	4
area	String		Indicate the id is for forum or topic. default is for forum. Valid value is 'forum' and 'topic'	4

Output Parameters:

Name	Type	Required?	Description	Level
member_count	Int	yes	number of members	3
guest_count	Int	yes	number of guest users	3
list	Array of Hash table	yes		3
user_id	String	yes		4
username	byte[]	yes	required in API level 4 as display name, if no display name, return login name	4
icon_url	String		user avatar full url	3. Obsoleted in Level 4.
user_name	byte[]	yes	Will be replaced by key 'username' in API level 4	3. Obsoleted in Level 4
display_text	byte[]		free text to be displayed under the user name in the online list. E.g. in vBulletin it can display what the user is currently doing. In API Leve 4, it can also returns [TOPIC] BBCode: this is to support clickable topic the user is currently reviewing.	3,4
topic_id	String		Required if [TOPIC] BBCode is presented in the display_text above.	4
from	String		Indicate where is this user browsing from. Valid data: browser/mobile/tapatalk/byo. Default as browser. 'byo' means user was on tapatalk 'build your own' app.