Instructions for showing KB articles belonging to a section, in HappyFox

Author: Anirudh S

README.md

@@ -75,16 +75,6 @@ Installating the HelpStack library is fairly straight-forward.
           exclude group: 'org.apache.httpcomponents', module: 'httpmime'
         }
 
-### External Dependencies
-
-HelpStack depends on the following libraries:
-
-    com.android.support:appcompat-v7:20.0.0
-    com.google.code.gson:gson:2.2.4
-    org.apache.httpcomponents:httpmime:4.2.6
-    com.mcxiaoke.volley:library-aar:1.+
-
-
 ## Using the Library
 
 Broadly speaking, there are just 3 steps to begin using HelpStack within your app:
@@ -108,7 +98,6 @@ Create a custom *Application* class which extends the **Application** class. Be
 Obtain the necessary credentials for the gear of your choice and create a suitable Gear object. Set the Gear object with *HSHelpStack* instance only once. 
 
 ##### i. HappyFox:
-Credentials: *HappyFox Account URL*, *API Key*, *Auth Code*, *Category ID* and *Priority ID*.
 
     public class HSApplication extends Application {
       
@@ -129,6 +118,9 @@ Credentials: *HappyFox Account URL*, *API Key*, *Auth Code*, *Category ID* and *
                 "<Category ID>",
                 "<Priority ID>");
         
+        // [Optional] Set the Section Id of your Knowledge Base articles
+        happyfoxGear.setSectionId("<Section id>");
+        
         // Set the Gear
         helpStack.setGear(happyfoxGear);
       }
@@ -137,16 +129,16 @@ Credentials: *HappyFox Account URL*, *API Key*, *Auth Code*, *Category ID* and *
 
 The API key and Auth code can be found in your HappyFox account under *Manage* > *Integrations*. You can generate an API key and Auth code by clicking on the API configure link.
 
-HappyFox requires that the Priority ID and Category ID cannot be nil. This is the ID of the priority and the category with which tickets will be created when a customer reports an issue. 
+Priority ID and Category ID cannot be nil. These are the ID's of the priority and the category with which tickets will be created. Setting the Section ID of your KB articles is optional.
 
 *Example*:
 
     https://example.happyfox.com/api/1.1/json/priorities/ 
     https://example.happyfox.com/api/1.1/json/categories/
+    https://example.happyfox.com/api/1.1/json/kb/sections/
 
 
 ##### ii. Zendesk:
-Credentials: *Zendesk Account URL*, *Staff Email address* and *API token*.
 
     public class HSApplication extends Application {
       
@@ -174,7 +166,6 @@ Credentials: *Zendesk Account URL*, *Staff Email address* and *API token*.
 The token can be found in your Zendesk account under Settings > Channels > API.
 
 ##### iii. Desk:
-**Credentials**: *Desk Account URL*, *To Help Email address*, *Staff Email address* and *Staff password*
 
     public class HSApplication extends Application {
      
@@ -277,6 +268,15 @@ Override the styles specified in **/values/hs_custom_theme.xml**
 
   If you want the complete look-and-feel of a theme, you might also want to update the color of your app's Action bar.
 
+
+## External Dependencies
+
+HelpStack depends on the following libraries:
+
+    com.android.support:appcompat-v7:20.0.0
+    com.google.code.gson:gson:2.2.4
+    org.apache.httpcomponents:httpmime:4.2.6
+    com.mcxiaoke.volley:library-aar:1.+
 
 ## About
 For more information about HelpStack, visit [helpstack.io](http://www.helpstack.io).

helpstack/src/com/tenmiles/helpstack/gears/HSHappyfoxGear.java

@@ -81,8 +81,7 @@ public class HSHappyfoxGear extends HSGear {
 	private String auth_code;
 	private String priority_id;
 	private String category_id;
-
-	public String hf_section_id;
+	private String section_id;
 
     // This are cached here so server call can be minimized and improve the speed of UI
     JSONArray allSectionsArray;
@@ -113,7 +112,7 @@ public void fetchKBArticle(String cancelTag, HSKBItem section, RequestQueue queu
 		if (section == null) {
 			// This is first request of sections 
 
-			if (this.hf_section_id == null) {
+			if (this.section_id == null) {
 				// Fetch all sections
 				String url = getApiUrl().concat("kb/sections/");
 
@@ -136,7 +135,7 @@ public void onResponse(JSONArray sectionsArray) {
 			}
 			else {
 				// Fetch individual section
-				String url = getApiUrl().concat("kb/section/").concat(this.hf_section_id).concat("/");
+				String url = getApiUrl().concat("kb/section/").concat(this.section_id).concat("/");
 
 				JsonObjectRequest request = new JsonObjectRequest(url, null, new HappyfoxArrayBaseListener<JSONObject>(success, errorListener) {
 
@@ -342,6 +341,10 @@ public void onResponse(JSONObject response) {
 
 	}
 
+    public void setSectionId(String sectionId) {
+        this.section_id = sectionId;
+    }
+
     private HSKBItem[] getArticlesFromSection(JSONObject sectionObject) throws JSONException {
         JSONArray articleArray = sectionObject.getJSONArray("articles");
         ArrayList<HSKBItem> kbArticleArray = new ArrayList<HSKBItem>();