Database plugin

The Database plugin allows custom attributes to be captured and associated to the conversation.

When Database plugin is ready to accept commands, it will publish ready event. It's recommended to subscribe to this event before calling any commands in this plugin. If the ready event is already published before you subscribe to it, it will simply republish again ensuring your callback function gets executed.

• Commands
• Database.set
• Database.update
• Database.get
• Database.remove
• Events
• Database.ready
• Database.removed
• Database.updated

Set the database with the provided data. If the customAttributes property already exists in the database, it will simply update with the new data (shallow merge).

Options:

Genesys("command", "Database.set", { messaging: { customAttributes: { key: 'value' }}},
function(data){ /* fulfilled, returns data */}, function(){ /* rejected */ });

{
messaging: {
customAttributes: {}
},
..
}

Published event: Database.updated

Update the existing database with the new data (deep merge).

Options:

Genesys("command", "Database.update", { messaging: { customAttributes: { key: 'value2' }}},
function(data){ /* fulfilled, returns data */}, function(){ /* rejected */ });

{
messaging: {
customAttributes: {}
},
..
}

Published event: Database.updated

Retrieve the data value of an object property name passed in the command. If no object property name is provided, the entire database object is returned.

Options:

Genesys("command", "Database.get", { name: "messaging.customAttributes" },
function(data){ /* fulfilled, returns data */}, function(){ /* rejected */ });

{ key: 'value2', ...}

{ messaging: { customAttributes: { } }, ... }

Delete an object property and its associated data from the Database plugin.

Options:

Published event: Database.removed

Genesys("command", "Database.remove", { name: "messaging.customAttributes" },
function(data){ /* fulfilled, returns data */}, function(){ /* rejected */ });

Published when the Database plugin is initialized.

Data: Not applicable.

Genesys("subscribe", "Database.ready", function() {
console.log("Database plugin is ready.")
});

Published when customAttributes are updated in the database.

Data: Updated database object

Genesys("subscribe", "Database.updated", function(e){
console.log(e.data) // Updated database object
});

Published when customAttributes are removed from the database.

Data: Updated database object

Genesys("subscribe", "Database.removed", function(e){
console.log(e.data) // Updated database object
});