Sample angular service for zoho widget api

Sample angular service for zoho widget api

After a week of frustration getting this to work (granted I'm still a newbie at web development) I thought that I should share the fruits of my development. Below you should have the basics of an Angular service written in Typescript that you'll be able to drop into just about any angular application.

I thought that I should pay it forward after all the help I got here for getting it to work in the first place.
  1. import {  Injectable } from '@angular/core';
  2. declare var ZOHO: any;

  4. @Injectable({
  5.   providedIn: 'root'
  6. })
  7.   /**
  8.    * This is a service that encapsulates the zoho api for widgets. This service requires that the sdk js file is loaded
  9.    * See https://www.zoho.com/creator/newhelp/app-settings/widgets/creator-api-for-widgets.html for more details.
  10.    */
  11. export class ZohoInterfaceService {

  13.   recordOps = ZOHO.CREATOR.API;
  14.   IsInitialised: boolean = false;
  15.   queryParams: any;
  16.   constructor() {
  17.   }
  18.   /**
  19.    * Initialises the zoho creator interface
  20.    *
  21.    * @returns A Promise containing the query parameters
  22.    */
  23.   Initialise(): Promise<any> {
  24.     var p: Promise<any> = new Promise((resolve, reject) => {
  25.       var creatorSdkPromise = ZOHO.CREATOR.init();
  26.       creatorSdkPromise.then(this.InititPromise.bind(null, this, resolve)).catch(function (error) {
  27.         console.log("Creator initialisation failed");
  28.         console.log(error);
  29.         reject(error)
  30.       })
  31.     })
  32.     return p;
  33.   }

  35.   private InititPromise(service: ZohoInterfaceService, resolve, data) {
  36.     service.queryParams = ZOHO.CREATOR.UTIL.getQueryParams();
  37.     console.log("Creator Initialised");
  38.     console.log(data);
  39.     service.recordOps = ZOHO.CREATOR.API;
  40.     service.IsInitialised = true;
  41.     resolve(data);
  42.   }
  43.   /**
  44.    *
  45.    * @param uid - The unique id of the item that you are looking for
  46.    * @param report - The report that you want to get the item from
  47.    * @returns a promise containing the results of the search.
  48.    */
  49.   GetRecord(uid: string, report: string): Promise<any> {
  50.     var config = {
  51.       reportName: report,
  52.       id: uid
  53.     }
  54.     console.log("Config :");
  55.     console.log(config);
  56.     return <Promise<any>>this.recordOps.getRecordById(config);
  57.   }

  59.   /**
  60.    *
  61.    * @param criteria - The criteria that needs to be applied to the search
  62.    * @param report - The report that you want to search
  63.    * @returns a promise containing the results of the search
  64.    */
  65.   GetAllRecords(criteria: string, report: string): Promise<any> {
  66.     var config = {
  67.       criteria: criteria,
  68.       reportName: report
  69.     }
  70.     return this.recordOps.getAllRecords(config);
  71.   }
  72. }