JKioskLibrary

All the JIIT Webkiosk data in a nice lib for Android Developers

To use this library in your project, do as follows:

1. In your top level build.gradle file, in the repository section add the maven { url 'https://jitpack.io' } as shown below

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

2. Add the JKioskLibrary dependency in your app level build.gradle file

compile 'com.github.gurleensethi:JKioskLibrary:v1.0.0'

Usage and API

All the apis can be accessed by using the JKiosk object, so suppose to access all semesters of a user, write JKiosk.getSemestersApi(). It will return the KioskSemester object which can be used to reterive the list of all semesters.

All the Api's will return a Kiosk object, this object contains the function to get the required data. To get the data a callback has to be registered, all the Kiosk objects takes an object of ResultCallbackContract that can be registered using addResultCallback(ResultCallbackContract<T> callback). The callback has has two methods, onResult(T result) and onError(Exception e). onResult(T result) will provide a Result object containing the required data.

JKiosk.getSomeApi()
      .getData(WebkioskCredentails)
      .addResultCallback(new ResultCallbackContract<ResultObject>() {
          @Override
          public void onResult(ResultObject) {
              //Retrieve data take action
          }
          
          @Override
          public void onError(Exception e) {
              //Notify user about error
          }
      });

To remove a callback just call the removeCallback() function on the Kiosk object.

Note

Since it takes a couple of seconds to get data from Webkiosk, JKiosk does all the processing in a background Thread and provides the result on Android's MainThread so you don't need to handle any kind of threading.

Index

• Best Practices
• Supported Colleges
• WebkioskCredentials
• Login
• Semesters
• Subjects
• Subject Faculty
• Attendance
• Detail Attendance
• CGPA Report
• Exam Grades

Supported Colleges

Currently only two colleges are supported:

• JIIT (Code: JIIT)
• JIIT-128 (Code: J128)

While creating an instance of WebkioskCredentials you have to select which college you are using.

WebkioskCredentials("enrollment", "dob", "password", "college-code");

There is a utlity class named Colleges that contains the codes of the supported colleges. So for JIIT-128 it will look something like this

WebkioskCredentials("enrollment", "dob", "password", Colleges.JIIT_128);

for JIIT-62

WebkioskCredentials("enrollment", "dob", "password", Colleges.JIIT_62);

WebkioskCredentials

WebkioskCredentials is a java object that is packaged with the library and is required by all the API's for proper functioning. Its contructor takes 4 parameters: new WebkioskCredentials(enrollmentNumber, dateOfBirth, password, college-code). All three parameters are of type String. The dateOfBirth has to be passed in the format: dd-mm-yyyy. The college codes can be accessed from the College utility class.

Login

Obtain the KioskLogin object from JKiosk by calling the getLoginApi() method. KioskLogin contains a function named login(WebkioskCredentials) that takes WebkioskCredentials as a parameter. Add a callback to get the response from login API.

JKiosk.getLoginApi()
       .login(new WebkioskCredentials("enrollmentNumber", "dd-mm-yyyy", "password", "college-code"))
       .addResultCallback(new ResultCallbackContract<LoginResult>() {
            @Override
            public void onResult(LoginResult result) {
                if (result.isValidCredentials()) {
                    //Login successful
                } else {
                    //Wrong credentials
                }
            }

            @Override
            public void onError(Exception e) {
               //Handle any error here
            }
       });

The LoginResult object contains the result of login as a boolean value returned by the function isValidCredentials().

Go to the Best Practices section to learn and leverage the API in a better way.

Semesters

Obtain the KioskSemesters object from JKiosk by calling the getSemestersApi() method. KioskSemesters contains a function named getSemesters(WebkioskCredentials) that takes WebkioskCredentials as a parameter. Add a callback to get the response from semesters API.

The semesters are in format like 2016EVESEM 2016ODDSEM 2017ODDSEM. These semester codes will be required in further API's to get semester specific data.

JKiosk.getSemestersApi()
       .getSemesters(new WebkioskCredentials("enrollmentNumber", "dd-mm-yyyy", "password", "college-code"))
       .addResultCallback(new ResultCallbackContract<SemestersResult>() {
            @Override
            public void onResult(SemestersResult result) {
                for (String semester : result.getSemesters()) {
                    Log.d("Semester", semester);
                }
            }

            @Override
            public void onError(Exception e) {
                //Handle any error here
            }
       });

The SemestersResult object contains a list of semesters which can be accessed by calling getSemesters().

Go to the Best Practices section to learn and leverage the API in a better way.

Subjects

Obtain the KioskSubjects object from JKiosk by calling the getSubjectsApi() method. KioskSubjects contains two functions named getSubjects(WebkioskCredentials) and getSubjects(WebkioskCredentials, Semester). Add a callback to get the response from subjects API.

getSubjects(WebkioskCredentials) takes a WebkioskCredentials object and returns the default data of the current semester.

getSubjects(WebkioskCredentials, Semester) takes an extra parameter semester which is the code for the semester you want the details for. Semesters codes can be obtained from the Semesters API. So to fetch details for the semester with code 2015EVESEM the function will be:

getSubjects(WebkioskCredentials, "2015EVESEM");

JKiosk.getSubjectsApi()
       .getSubjects(new WebkioskCredentials("enrollmentNumber", "dd-mm-yyyy", "password", "college-code"))
       .addResultCallback(new ResultCallbackContract<SubjectResult>() {
            @Override
            public void onResult(SubjectResult result) {
                for (Subject subject : result.getSubjects()) {
                    subject.getSubjectName();
                    subject.getSubjectCredits();
                    subject.getSubjectType();
                    subject.getSubjectCode();
                }
            }

            @Override
            public void onError(Exception e) {
                //Handle any error here
            }
       });

The SubjectResult object contains a list of SubjectFaculty which can be accessed by calling getSubjects().

Go to the Best Practices section to learn and leverage the API in a better way.

Subject Faculty

Obtain the KioskSubjectFaculty object from JKiosk by calling the getSubjectFacultyApi() method. KioskSubjectFaculty contains two functions named getSubjectFaculty(WebkioskCredentials) and getSubjectFaculty(WebkioskCredentials, Semester). Add a callback to get the response from subject faculty API.

getSubjectFaculty(WebkioskCredentials) takes a WebkioskCredentials object and returns the default data of the current semester.

getSubjectFaculty(WebkioskCredentials, Semester) takes an extra parameter semester which is the code for the semester you want the details for. Semesters codes can be obtained from the Semesters API. So to fetch details for the semester with code 2015EVESEM the function will be:

getSubjectFaculty(WebkioskCredentials, "2015EVESEM");

JKiosk.getSubjectFacultyApi()
       .getSubjectFaculty(new WebkioskCredentials("enrollmentNumber", "dd-mm-yyyy", "password", "college-code"))
       .addResultCallback(new ResultCallbackContract<SubjectFacultyResult>() {
            @Override
            public void onResult(SubjectFacultyResult result) {
                for (SubjectFaculty subjectFaculty : result.getSubjectFaculties()) {
                    subjectFaculty.getSubjectName();
                    subjectFaculty.getLectureFaculty();
                    subjectFaculty.getTutorialFaculty();
                    subjectFaculty.getPracticalFaculty();
                    subjectFaculty.getSubjectCode();
                }
            }

            @Override
            public void onError(Exception e) {
                //Handle any error here
            }
       });

The SubjectFacultyResult object contains a list of SubjectFaculty which can be accessed by calling getSubjectFaculties().

Go to the Best Practices section to learn and leverage the API in a better way.

Attendance

Obtain the KioskAttendance object from JKiosk by calling the getAttendanceApi() method. KioskAttendance contains two functions named getAttendance(WebkioskCredentials) and getAttendance(WebkioskCredentials, Semester). Add a callback to get the response from attendance API.

getAttendance(WebkioskCredentials) takes a WebkioskCredentials object and returns the default data of the current semester.

getAttendance(WebkioskCredentials, Semester) takes an extra parameter semester which is the code for the semester y