Work with adapter.js

1
constructor(prongid, properties) {
2
  // Instantiate the AdapterBase super class
3
  super(prongid, properties);
4
5
  // Uncomment if you have things to add to the constructor, such as using your own properties.
6
  // Otherwise the constructor in adapterBase will be used.
7
  // Capture custom properties - they need to be defined in propertiesSchema.json
8
  if (this.allProps && this.allProps.myownproperty) {
9
    mypropvariable = this.allProps.myownproperty;
10
  }
11
}

1
sampleAPIcall(param1, param2, callback) {
2
  const meth = 'adapter-sampleAPIcall';
3
  const origin = `${this.id}-${meth}`;
4
  log.trace(origin);

1
/* HERE IS WHERE YOU VALIDATE DATA */
2
if (param1 === undefined || param1 === null || param1 === '') {
3
  const errorObj = this.requestHandlerInst.formatErrorObject(
4
    this.id, meth, 'Missing Data', ['param1'], null, null, null
5
  );
6
  log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
7
  return callback(null, errorObj);
8
}

1
/* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
2
// Format and prepare parameters as needed before building the object.
3
4
const reqObj = {
5
  payload: bodyToSendOnCall,                   // formatted based on requestDatatype
6
  uriPathVars: pathVariablesArray,             // array of path variable values
7
  uriQuery: queryParams,                       // JSON object of query parameters
8
  uriOptions: optionParams,                    // JSON object of option parameters
9
  addlHeaders: callSpecificAdditionalHeaders,  // JSON object of additional headers
10
  authData: dynamicAuthenticationBodyData,     // JSON object for dynamic auth data
11
  callProperties: dynamicCallProps,            // JSON object matching property structure
12
  filter: dynamicResponseFilter,              // JSONQuery string to filter the response
13
  priority: 1,                                // number corresponding to a defined priority
14
  event: eventname                            // event to trigger when data is returned
15
};

1
// identifyRequest(entity, action, requestObj, returnDataFlag, callback)
2
return this.requestHandlerInst.identifyRequest('entity', 'action', reqObj, true, (irReturnData, irReturnError) => {
3
4
  // Return any error from the libraries
5
  if (irReturnError) {
6
    /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
7
    return callback(null, irReturnError);
8
  }
9
10
  // Return an error if the response has no data
11
  if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
12
    const errorObj = this.requestHandlerInst.formatErrorObject(
13
      this.id, meth, 'Invalid Response', ['action'], null, null, null
14
    );
15
    log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
16
    return callback(null, errorObj);
17
  }
18
19
  /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
20
  return callback(irReturnData, null);
21
});