search_post

Function

Function Name	Description	Level
search_post	a simple search allows user to enter a query string and it will return a list of post that matched the query.	3

Input Parameters:

Name	Type	Required?	Description	Level
search_string	byte[]		query string. At least 3 characters to start the search. If search_id is provide, this parameter will be ignored.	3
start_num	Int	yes	For pagination. If start_num = 0 & last_num = 9, returns first 10 posts, sorted by date. If both are not presented, return first 20 posts	3
last_num	Int			3
search_id	String		for caching and for pagination support	4

Output Parameters:

Name	Type	Required?	Description	Level
total_post_num	Int	yes	returns total number of posts found	3
search_id	String		return the search id so the app can send the same id back to the server for pagination support	3
posts	Array of Hash table	yes	returns an array of topics	3
forum_id	String	yes		3
forum_name	byte[]	yes		3
topic_id	String	yes		3
topic_title	byte[]	yes	Remove all BBCode in title	3
post_id	String	yes		3
post_title	byte[]	yes		3
post_author_id	String			4
post_author_name	byte[]	yes		3
post_time	Date	yes	dateTime.iso8601 format. If this topic has no reply, use the topic creation time.	3
timestamp	String	yes	Timestamp of topic last reply
icon_url	String	yes	Return topic author avatar URL	3
short_content	byte[]		Characters display rules (should follow this sequence): 1) Remove all BBCode except [ur], [img]. 2) Convert "[url http://...]http://…..[/url]" to "[url]". 3) Convert "[img]http://…..[/img]" to "[img]". 4) Remove "Last edited by..." tag at the end. 5) Remove all non-displayable characters (e.g. \n, \t, etc). 6) Remove all whitespace, /n and /r at the begining and ending of the content. 7) return only first 200 characters	3