If_ResponseForum
ResponseForum interface provides commands for browsing threaded responses and custom form result (annex) records
|
| load | | Called to load a list of annex data/responses into the session. | | | | Optional arguments: | | owner_id = Owner ID of responses to browse or 0 for all owners (default=0) | | orderby = Valid values: name,priceasc,pricedesc,id,partno,none (default=name) | | search_text = Any text used to search in response name or descriptions | | is_response = Tag to determine whether or not this is a response | | | | fields to use if this is a response | | article_id = Article ID of responses to browse or 0 for all owners (default=0) |
|
| resume | | Resumes an existing response browse session | | | | Optional arguments: | | startat - response counter to start at (default=-1) | | Returns 'yes' or 'no' depending on whether there was a session to resume |
|
| isready | | Returns 'yes' or 'no' depending on if we have any more responses to view | | This will also return 'no' if we've just loaded an response list but haven't | | called next yet! |
|
| templateresponselist | | This command outputs the annex data/response according to a template as given below: | | | | ##ANNEXID## - Annex ID of this response | | | | fields to use if this is a response: | | ##AUTHOR## - Author Name of the response | | ##EMAIL## - Author's Email | | ##TITLE## - Title of the response | | ##FILE## - Response Text from file | | | | Arguments: | | template - Template string (required) | | indent - String to replace ##INDENT## with (default=' ') | | | | For totals use the 'total' command after listing the line. It's your responsibility to construct your own table or however else you'd like to display this. | | | | Returns 'ok' or 'error:...' |
|
| totalresponsecount | | Prints and returns total number of items in current cursor |
|
