JavaScript API documentation

About JavaScript API

note

The JavaScript API is supported in the redaction and restriction data regulation models only.

note

To use JavaScript API from your LWC, you need to enable Lightning Web Security in your org. This is a Salesforce security requirement.

Source diagram

Source diagram

Configuring the storage

To access your data on the InCountry platform by using the JavaScript API, you need to create an instance of the InCountryStorage class using the create method.

init(): InCountryStorage

Below you can find an example of how to set up the storage:

/<your\_aura\_component>/<your\_aura\_component>.cmp

<aura:component implements="force:appHostable,flexipage:availableForAllPageTypes,flexipage:availableForRecordHome,force:hasRecordId" access="global" >
  <aura:attribute name="storage" type="Object"/>
  <aura:handler name="init" value="{!this}" action="{!c.init}"/>

    <testIncountry1:inCountry aura:id="InCountry"></testIncountry1:inCountry>
    <c:your_lwc_component storage="{!v.storage}" aura:id="your_lwc_component"></c:your_lwc_component>
</aura:component>

/<your\_aura\_component>/<your\_aura\_component>Controller.js

({
  init : function(component, event, helper) {
        let InCountry = component.find('InCountry');
        let storage = InCountry.create();
        component.set('v.storage', storage);
        // custom code ...
  },

  yourAction : function(component, event, helper) {
    let storage = component.get('v.storage');
        // custom code for the action
    },

    anotherAction : function(cmp, event, helper) {
        let storage = component.get('v.storage');
        // custom code for the action
    }
})

Searching for data records

You can use the find method to search for specific data records by their fields.

find(
    profile_keys: array,
    fields: array,
    limit: number
): Promise<Object[]>

Below you can find an example of how to search for data records:

storage
  .find(
      ['003P000001TJl6uIAD'],
      ["FirstName","LastName"],
      1
  )
  .then(records => {
      console.log(records);
  })
  .catch(error => {
      console.error(error);
  });

Sample response from the JavaScript API:

[
  {
    "payload": {
      "FirstName": "Mark",
      "LastName": "Taylor"
    },
    "key": "003P000001TJl6uIAD",
    "range_key": null,
    "profile_key": "003P000001TJl6uIAD",
    "service_key5": "Contact",
    "key2": null,
    "key1": null
  }
]

Creating and updating data records

note

Be careful when updating the existing data records and ensure that you have specified all the fields for the record you want to update. You may accidentally overwrite field values with empty values.

You can use the write method to create new or replace the existing data records by the recordKey field.

write(
    profile_key: string,
    payload: Object
): Promise<Object>

Below you can find an example of how to create a new or replace the existing data record:

storage
  .write(
      '003P000001TJl6uIAD',
      {
          FirstName: "Mark",
          LastName: "Taylor",
          Salutation: "Mr."
      }
  )
  .then(record => {
      console.log(record)
  })
  .catch(error => {
      console.error(error);
  });

Sample response from the JavaScript API for the create operation:

{
  "country": "sa",
  "key": "003P000001TJl6uIAD",
  "record_key": "003P000001TJl6uIAD",
  "parent_key": null,
  "profile_key": "003P000001TJl6uIAD",
  "range_key": null,
  "range_key1": null,
  "range_key2": null,
  "range_key3": null,
  "range_key4": null,
  "range_key5": null,
  "range_key6": null,
  "range_key7": null,
  "range_key8": null,
  "range_key9": null,
  "range_key10": null,
  "body": "{\"FirstName\":\"Mark\",\"LastName\":\"Taylor\",\"Salutation\":\"Mr.\"}",
  "precommit_body": null,
  "key1": null,
  "key2": null,
  "key3": null,
  "key4": null,
  "key5": null,
  "key6": null,
  "key7": null,
  "key8": null,
  "key9": null,
  "key10": null,
  "key11": null,
  "key12": null,
  "key13": null,
  "key14": null,
  "key15": null,
  "key16": null,
  "key17": null,
  "key18": null,
  "key19": null,
  "key20": null,
  "service_key1": null,
  "service_key2": null,
  "service_key5": "Contact"
}

Sample response from the JavaScript API for the replace operation:

{
  "country": "sa",
  "key": "003P000001TJl6uIAD",
  "record_key": "003P000001TJl6uIAD",
  "profile_key": "003P000001TJl6uIAD",
  "body": "{\"FirstName\":\"Mark\",\"LastName\":\"Taylor\",\"Salutation\":\"Mr.\"}",
  "service_key5": "Contact"
}

Deleting data records

You can use the delete method to delete data records by the recordKey field from the InCountry platform.

delete(
    profile_key: string
): Promise<boolean>

Below you can find an example of how to delete a data record:

storage
  .delete('0030x00000xDVD6AAO')
  .then(response => {
      console.log(response)
  })
  .catch(error => {
      console.error(error);
  });

Creating and updating multiple data records

note

Be careful when updating the existing data records and ensure that you have specified all the fields for the records you want to update. You may accidentally overwrite field values with empty values.

You can use the batchWrite method to create or replace multiple data records.

batchWrite(
    records: Object {{id: string, payload: Object}[]}
): Promise<Object[]>

Below you can find an example of how to create or replace multiple data records:

storage
  .batchWrite([
      {
          recordId: '003P000001TJl6uIAD',
          payload: {
              FirstName: "Mark",
              LastName: "Taylor",
              Salutation: "Mr."
          }
      }
  ])
  .then(({records, errors}) => {
      console.log(records, errors);
  })
  .catch(error => {
      console.error(error);
  });

Sample response from the JavaScript API for the create operation:

{
  "data": [
    {
      "country": "sa",
      "key": "003P000001TJl6uIAD",
      "record_key": "003P000001TJl6uIAD",
      "parent_key": null,
      "profile_key": "003P000001TJl6uIAD",
      "range_key": null,
      "range_key1": null,
      "range_key2": null,
      "range_key3": null,
      "range_key4": null,
      "range_key5": null,
      "range_key6": null,
      "range_key7": null,
      "range_key8": null,
      "range_key9": null,
      "range_key10": null,
      "body": "{\"FirstName\":\"Mark\",\"LastName\":\"Taylor\",\"Salutation\":\"Mr.\"}",
      "precommit_body": null,
      "key1": null,
      "key2": null,
      "key3": null,
      "key4": null,
      "key5": null,
      "key6": null,
      "key7": null,
      "key8": null,
      "key9": null,
      "key10": null,
      "key11": null,
      "key12": null,
      "key13": null,
      "key14": null,
      "key15": null,
      "key16": null,
      "key17": null,
      "key18": null,
      "key19": null,
      "key20": null,
      "service_key1": null,
      "service_key2": null,
      "service_key5": "Contact"
    }
  ],
  "errors": null
}

Sample response from the JavaScript API for the replace operation:

{
  "data": [
    {
      "country": "sa",
      "key": "003P000001TJl6uIAD",
      "record_key": "003P000001TJl6uIAD",
      "profile_key": "003P000001TJl6uIAD",
      "body": "{\"FirstName\":\"Mark\",\"LastName\":\"Taylor\",\"Salutation\":\"Mr.\"}",
      "service_key5": "Contact"
    }
  ],
  "errors": null
}

Sample response from the JavaScript API for the create/replace operation with errors:

{
  "data": null,
  "errors": [
    {
      "recordId": "003P000001TJl6uIAD",
      "message": "<MESSAGE_TEXT>",
      "type": "<ERROR_TYPE>"
    }
  ]
}

Deleting multiple data records

You can use the batchDelete method to delete multiple records of data.

batchDelete(
  recordIds: array
): {Promise<{data: string[], errors: {recordId: !string, message: !string}[]}>[]}

Below you can find an example of how to delete multiple data records:

storage
  .batchDelete(['003P000001TJl6uIAD', '003P000001TJl6uIAA'])
  .then(({ data, errors }) => {
    console.log(data, errors);
  })
  .catch(error => {
    console.error(error);
  });
← Apex SDKRetrieving record statistics →