ComponentGlobalDataStoreService

The Component Global Data Store Service allows you to get and set data for components in the Global Data Store.

Methods

getComponentData

Description

• Gets data of for a component by Id.

Arguments:

componentId: String The identifier for your component.

Code Example

let myComponentData = await digideckCore.componentGlobalDataStoreService.getComponentData(myComponentId);

setComponentData

Description

• Sets data for a component by Id. This will create the data record if it does not already exist or overwrite it if it does exist.

Arguments:

componentId: String The identifier for your component.
data: Object The component-data properties you would like to upsert.

Code Example

let updateProps = { value: { yellow: true, blue: false } };
let updatedComponentData = await digideckCore.componentGlobalDataStoreService.setComponentData(myComponentId, updateProps);

getComponentGroupData

Description

• Gets all data-records for your component by groupKey, componentId and filter.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey in which all of your data records will be filtered by.
filter: Object Object for additional filtering of records to be returned.

Code Example

let groupKey = 'dogs';
let filter = { take: 10 };
let dogsComponentData = await digideckCore.componentGlobalDataStoreService.getComponentGroupData(myComponentId, groupKey, filter);

addComponentGroupData

Description

• Creates a new data-record for your component flagged by groupKey.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey to flag your new component data record under.
data: Object Body of record to be created.

Code Example

let groupKey = 'dogs';
let data = { value: { color: 'white', ears: 'peaky', runs: 'fast' } };
let newDogsComponentDataRecord = await digideckCore.componentGlobalDataStoreService.addComponentGroupData(
    myComponentId,
    groupKey,
    data
);

updateComponentGroupDataById

Description

• Updates a component data record that is flagged by groupKey, by Id.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your component-data record.
data: Object Properties to be updated.

Code Example

let newDogsComponentDataRecord = await digideckCore.componentGlobalDataStoreService.addComponentGroupData(
    myComponentId,
    groupKey,
    data
);

let id = newDogsComponentDataRecord.body._id;
let groupKey = 'dogs';
let data = { value: { color: 'brown', ears: 'floppy', runs: 'slow' } };
let updatedDogsComponentDataRecord = await digideckCore.componentGlobalDataStoreService.updateComponentGroupDataById(
    myComponentId,
    groupKey,
    id,
    data
);

getComponentGroupDataById

Description

• Gets a component data record that is flagged by groupKey, by Id.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your component-data record.

Code Example

let newDogsComponentDataRecord = await digideckCore.componentGlobalDataStoreService.addComponentGroupData(
    myComponentId,
    groupKey,
    data
);

let id = newDogsComponentDataRecord.body._id;
let groupKey = 'dogs';
let updatedDogsComponentDataRecord = await digideckCore.componentGlobalDataStoreService.getComponentGroupDataById(
    myComponentId,
    groupKey,
    id
);

deleteComponentGroupDataById

Description

• Deletes (flags as isDeleted: true) a component data record that is flagged by groupKey, by Id.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your component-data record.

Code Example

let newDogsComponentDataRecord = await digideckCore.componentGlobalDataStoreService.addComponentGroupData(
    myComponentId,
    groupKey,
    data
);

let id = newDogsComponentDataRecord.body._id;
let groupKey = 'dogs';
let updatedDogsComponentDataRecord = await digideckCore.componentGlobalDataStoreService.deleteComponentGroupDataById(
    myComponentId,
    groupKey,
    id
);

DeckGlobalDataStoreService

The Deck Global Data Store Service allows you to get and set data for Master Decks in the Global Data Store.

Methods

getDeckData

Description

• Gets data of for a deck by Id.

Arguments:

deckId: String The identifier for your deck.

Code Example

let myDeckData = await digideckCore.deckGlobalDataStoreService.getDeckData(myDeckId);

setDeckData

Description

• Sets data for a deck by Id. This will create the data record if it does not already exist or overwrite it if it does exist.

Arguments:

deckId: String The identifier for your deck.
data: Object The deck-data properties you would like to upsert.

Code Example

let updateProps = { value: { yellow: true, blue: false } };
let updatedDeckData = await digideckCore.deckGlobalDataStoreService.setDeckData(myDeckId, updateProps);

getDeckGroupData

Description

• Gets all data-records for your deck by groupKey, deckId and filter.

Arguments:

deckId: String The identifier for your deck.
groupKey: String The groupKey in which all of your data records will be filtered by.
filter: Object Object for additional filtering of records to be returned.

Code Example

let groupKey = 'dogs';
let filter = { take: 10 };
let dogsDeckData = await digideckCore.deckGlobalDataStoreService.getDeckGroupData(myDeckId, groupKey, filter);

addDeckGroupData

Description

• Creates a new data-record for your deck flagged by groupKey.

Arguments:

deckId: String The identifier for your deck.
groupKey: String The groupKey to flag your new deck data record under.
data: Object Body of record to be created.

Code Example

let groupKey = 'dogs';
let data = { value: { color: 'white', ears: 'peaky', runs: 'fast' } };
let newDogsDeckDataRecord = await digideckCore.deckGlobalDataStoreService.addDeckGroupData(
    myDeckId,
    groupKey,
    data
);

updateDeckGroupDataById

Description

• Updates a deck data record that is flagged by groupKey, by Id.

Arguments:

deckId: String The identifier for your deck.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your deck-data record.
data: Object Properties to be updated.

Code Example

let newDogsDeckDataRecord = await digideckCore.deckGlobalDataStoreService.addDeckGroupData(
    myDeckId,
    groupKey,
    data
);

let id = newDogsDeckDataRecord.body._id;
let groupKey = 'dogs';
let data = { value: { color: 'brown', ears: 'floppy', runs: 'slow' } };
let updatedDogsDeckDataRecord = await digideckCore.deckGlobalDataStoreService.updateDeckGroupDataById(
    myDeckId,
    groupKey,
    id,
    data
);

getDeckGroupDataById

Description

• Gets a deck data record that is flagged by groupKey, by Id.

Arguments:

deckId: String The identifier for your deck.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your deck-data record.

Code Example

let newDogsDeckDataRecord = await digideckCore.deckGlobalDataStoreService.addDeckGroupData(
    myDeckId,
    groupKey,
    data
);

let id = newDogsDeckDataRecord.body._id;
let groupKey = 'dogs';
let updatedDogsDeckDataRecord = await digideckCore.deckGlobalDataStoreService.getDeckGroupDataById(
    myDeckId,
    groupKey,
    id
);

deleteDeckGroupDataById

Description

• Deletes (flags as isDeleted: true) a deck data record that is flagged by groupKey, by Id.

Arguments:

deckId: String The identifier for your deck.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your deck-data record.

Code Example

let newDogsDeckDataRecord = await digideckCore.deckGlobalDataStoreService.addDeckGroupData(
    myDeckId,
    groupKey,
    data
);

let id = newDogsDeckDataRecord.body._id;
let groupKey = 'dogs';
let updatedDogsDeckDataRecord = await digideckCore.deckGlobalDataStoreService.deleteDeckGroupDataById(
    myDeckId,
    groupKey,
    id
);

PresentationGlobalDataStoreService

The Presentation Global Data Store Service allows you to get and set data for Master Presentations in the Global Data Store.

Methods

getPresentationData

Description

• Gets data of for a presentation by Id.

Arguments:

presentationId: String The identifier for your presentation.

Code Example

let myPresentationData = await digideckCore.presentationGlobalDataStoreService.getPresentationData(myPresentationId);

setPresentationData

Description

• Sets data for a presentation by Id. This will create the data record if it does not already exist or overwrite it if it does exist.

Arguments:

presentationId: String The identifier for your presentation.
data: Object The presentation-data properties you would like to upsert.

Code Example

let updateProps = { value: { yellow: true, blue: false } };
let updatedPresentationData = await digideckCore.presentationGlobalDataStoreService.setPresentationData(myPresentationId, updateProps);

getPresentationGroupData

Description

• Gets all data-records for your presentation by groupKey, presentationId and filter.

Arguments:

presentationId: String The identifier for your presentation.
groupKey: String The groupKey in which all of your data records will be filtered by.
filter: Object Object for additional filtering of records to be returned.

Code Example

let groupKey = 'dogs';
let filter = { take: 10 };
let dogsPresentationData = await digideckCore.presentationGlobalDataStoreService.getPresentationGroupData(myPresentationId, groupKey, filter);

addPresentationGroupData

Description

• Creates a new data-record for your presentation flagged by groupKey.

Arguments:

presentationId: String The identifier for your presentation.
groupKey: String The groupKey to flag your new presentation data record under.
data: Object Body of record to be created.

Code Example

let groupKey = 'dogs';
let data = { value: { color: 'white', ears: 'peaky', runs: 'fast' } };
let newDogsPresentationDataRecord = await digideckCore.presentationGlobalDataStoreService.addPresentationGroupData(
    myPresentationId,
    groupKey,
    data
);

updatePresentationGroupDataById

Description

• Updates a presentation data record that is flagged by groupKey, by Id.

Arguments:

presentationId: String The identifier for your presentation.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your presentation-data record.
data: Object Properties to be updated.

Code Example

let newDogsPresentationDataRecord = await digideckCore.presentationGlobalDataStoreService.addPresentationGroupData(
    myPresentationId,
    groupKey,
    data
);

let id = newDogsPresentationDataRecord.body._id;
let groupKey = 'dogs';
let data = { value: { color: 'brown', ears: 'floppy', runs: 'slow' } };
let updatedDogsPresentationDataRecord = await digideckCore.presentationGlobalDataStoreService.updatePresentationGroupDataById(
    myPresentationId,
    groupKey,
    id,
    data
);

getPresentationGroupDataById

Description

• Gets a presentation data record that is flagged by groupKey, by Id.

Arguments:

presentationId: String The identifier for your presentation.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your presentation-data record.

Code Example

let newDogsPresentationDataRecord = await digideckCore.presentationGlobalDataStoreService.addPresentationGroupData(
    myPresentationId,
    groupKey,
    data
);

let id = newDogsPresentationDataRecord.body._id;
let groupKey = 'dogs';
let updatedDogsPresentationDataRecord = await digideckCore.presentationGlobalDataStoreService.getPresentationGroupDataById(
    myPresentationId,
    groupKey,
    id
);

deletePresentationGroupDataById

Description

• Deletes (flags as isDeleted: true) a presentation data record that is flagged by groupKey, by Id.

Arguments:

presentationId: String The identifier for your presentation.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your presentation-data record.

Code Example

let newDogsPresentationDataRecord = await digideckCore.presentationGlobalDataStoreService.addPresentationGroupData(
    myPresentationId,
    groupKey,
    data
);

let id = newDogsPresentationDataRecord.body._id;
let groupKey = 'dogs';
let updatedDogsPresentationDataRecord = await digideckCore.presentationGlobalDataStoreService.deletePresentationGroupDataById(
    myPresentationId,
    groupKey,
    id
);

warning

DEPRECATED: digideckCore.globalDataStoreService is deprecated. Use the more specific ComponentGlobalDataStoreService with the same methods as GlobalDataStoreService, or DeckGlobalDataStoreService/PresentationGlobalDataStoreSErvice

Global Data Store Service

The Global Data Store Service allows you to get and set data for components in the Global Data Store.

Methods

getComponentData

Description

• Gets data of for a component by Id.

Arguments:

componentId: String The identifier for your component.

Code Example

let myComponentData = await digideckCore.globalDataStoreService.getComponentData(myComponentId);

setComponentData

Description

• Sets data for a component by Id. This will create the data record if it does not already exist or overwrite it if it does exist.

Arguments:

componentId: String The identifier for your component.
data: Object The component-data properties you would like to upsert.

Code Example

let updateProps = { value: { yellow: true, blue: false } };
let updatedComponentData = await digideckCore.globalDataStoreService.setComponentData(myComponentId, updateProps);

getComponentGroupData

Description

• Gets all data-records for your component by groupKey, componentId and filter.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey in which all of your data records will be filtered by.
filter: Object Object for additional filtering of records to be returned.

Code Example

let groupKey = 'dogs';
let filter = { take: 10 };
let dogsComponentData = await digideckCore.globalDataStoreService.getComponentGroupData(myComponentId, groupKey, filter);

addComponentGroupData

Description

• Creates a new data-record for your component flagged by groupKey.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey to flag your new component data record under.
data: Object Body of record to be created.

Code Example

let groupKey = 'dogs';
let data = { value: { color: 'white', ears: 'peaky', runs: 'fast' } };
let newDogsComponentDataRecord = await digideckCore.globalDataStoreService.addComponentGroupData(
    myComponentId,
    groupKey,
    data
);

updateComponentGroupDataById

Description

• Updates a component data record that is flagged by groupKey, by Id.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your component-data record.
data: Object Properties to be updated.

Code Example

let newDogsComponentDataRecord = await digideckCore.globalDataStoreService.addComponentGroupData(
    myComponentId,
    groupKey,
    data
);

let id = newDogsComponentDataRecord.body._id;
let groupKey = 'dogs';
let data = { value: { color: 'brown', ears: 'floppy', runs: 'slow' } };
let updatedDogsComponentDataRecord = await digideckCore.globalDataStoreService.updateComponentGroupDataById(
    myComponentId,
    groupKey,
    id,
    data
);

getComponentGroupDataById

Description

• Gets a component data record that is flagged by groupKey, by Id.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your component-data record.

Code Example

let newDogsComponentDataRecord = await digideckCore.globalDataStoreService.addComponentGroupData(
    myComponentId,
    groupKey,
    data
);

let id = newDogsComponentDataRecord.body._id;
let groupKey = 'dogs';
let updatedDogsComponentDataRecord = await digideckCore.globalDataStoreService.getComponentGroupDataById(
    myComponentId,
    groupKey,
    id
);

deleteComponentGroupDataById

Description

• Deletes (flags as isDeleted: true) a component data record that is flagged by groupKey, by Id.

Arguments:

componentId: String The identifier for your component.
groupKey: String The groupKey to your data is flagged by.
id: String The identifier for your component-data record.

Code Example

let newDogsComponentDataRecord = await digideckCore.globalDataStoreService.addComponentGroupData(
    myComponentId,
    groupKey,
    data
);

let id = newDogsComponentDataRecord.body._id;
let groupKey = 'dogs';
let updatedDogsComponentDataRecord = await digideckCore.globalDataStoreService.deleteComponentGroupDataById(
    myComponentId,
    groupKey,
    id
);