Skip to content

User Guide: SDKs > Flutter SDK > Invoking an Object Service

Invoking an Object Service

The OnlineObjectService Class provides methods that perform operations acting on the Volt Foundry endpoint, including basic CRUD operations.

Methods

The following methods are used by the OnlineObjectService class and its instantiations:

  1. Create
  2. Update
  3. Delete
  4. Fetch
  5. getMetadataOfObject
  6. getMetadataOfAllObjects

Create

Creates an object in the Volt Foundry endpoint

var voltmxSdkFlutter = VoltmxSdkFlutter();
var objectServiceName = "<Your objectServiceName here>";
var dataObjectName = "<Your dataObjectName here>";
final jsonData = {'name':'VoltMX', 'age': 45, 'gender': 'male'};
final bodyParamsData = json.encode(jsonData);
Map<String, String> headersData = {};
Map<String, String> queryParamsData = {};
voltmxSdkFlutter.create(objectServiceName, dataObjectName, bodyParamsData, headersData, queryParamsData, onSuccess: (response) {
    // Handle the success case here
},
onFailure: (response) {
    // Handle the failure case here
});

Update

Updates an object in the Volt Foundry endpoint.

var voltmxSdkFlutter = VoltmxSdkFlutter();
var objectServiceName = "<Your objectServiceName here>";
var dataObjectName = "<Your dataObjectName here>";
final jsonData = {'name':'IRIS', 'age': 45, 'gender': 'female'};
final bodyParamsData = json.encode(jsonData);
Map<String, String> headersData = {};
Map<String, String> queryParamsData = {};
voltmxSdkFlutter.update(objectServiceName, dataObjectName, bodyParamsData, headersData, queryParamsData, onSuccess: (response) {
    // Handle the success case here
},
onFailure: (response) {
    // Handle the failure case here
});

Delete

Deletes an object in the Volt Foundry endpoint.

var voltmxSdkFlutter = VoltmxSdkFlutter();
var objectServiceName = "<Your objectServiceName here>";
var dataObjectName = "<Your dataObjectName here>";
final jsonData = {'id':454};
final bodyParamsData = json.encode(jsonData);
Map<String, String> headersData = {};
Map<String, String> queryParamsData = {};
voltmxSdkFlutter.delete(objectServiceName, dataObjectName, bodyParamsData, headersData, queryParamsData, onSuccess: (response) {
    // Handle the success case here
},
onFailure: (response) {
    // Handle the failure case here
});

Fetch

Fetches an object from the server.

var voltmxSdkFlutter = VoltmxSdkFlutter();
var objectServiceName = "<Your objectServiceName here>";
var dataObjectName = "<Your dataObjectName here>";
String id = "2";
String bodyParamsData = "\$filter= id eq $id";
Map<String, String> headersData = {};
Map<String, String> queryParamsData = {};
voltmxSdkFlutter.fetch(objectServiceName, dataObjectName, bodyParamsData, headersData, queryParamsData, onSuccess: (response) {
    // Handle the success case here
},
onFailure: (response) {
    // Handle the failure case here
});

GetMetadataOfObject

Retrieves the metadata associated with an object that is defined in the service from the server or local store.

var voltmxSdkFlutter = VoltmxSdkFlutter();
var objectServiceName = "<Your objectServiceName here>";
var dataObjectName = "<Your dataObjectName here>";
bool getFromServer = true;
Map<String, String> headersData = {};
Map<String, String> queryParamsData = {};
voltmxSdkFlutter.getMetadataOfObject(objectServiceName, dataObjectName, getFromServer, headersData, queryParamsData, onSuccess: (response) {
    // Handle the success case here
},
onFailure: (response) {
    // Handle the failure case here
});

GetMetadataOfAllObjects

Retrieves the metadata associated with the objects that are defined in the service from the server.

var voltmxSdkFlutter = VoltmxSdkFlutter();
var objectServiceName = "<Your objectServiceName here>";
var dataObjectName = "<Your dataObjectName here>";
bool getFromServer = true;
Map<String, String> headersData = {};
Map<String, String> queryParamsData = {};
voltmxSdkFlutter.getMetadataOfAllObjects(objectServiceName, dataObjectName, getFromServer, headersData, queryParamsData, onSuccess: (response) {
    // Handle the success case here
},
onFailure: (response) {
    // Handle the failure case here
});