siteKiosk.remote.blackboard



Example:

 
// Add a new entry to the blackboard
siteKiosk.remote.blackboard.setValue("importantCategory.ImportantKey1", "ImportantValue1");

// Add another entry
siteKiosk.remote.blackboard.setValue("importantCategory.ImportantKey2", "ImportantValue2");

// Read the new added entry
console.log(siteKiosk.remote.blackboard.getValue("importantCategory.ImportantKey1"));
console.log(siteKiosk.remote.blackboard.getValue("importantCategory.ImportantKey2"));

// Read entries by a key prefix
console.log(siteKiosk.remote.blackboard.getValues("importantCategory.ImportantKey*"));

Edit this snippet on JSFiddle

Methods

getValue getValues removeValue setValue

Methods

getValue

  • Returns the first entry found by a specified key prefix.
    Use '*' as wildcard.

    Parameters

    • key: string

      The key prefix to serch for.

    Returns null | BlackboardEntry

getValues

  • Returns all entries found by a specified key prefix.
    Use '*' as wildcard.

    Parameters

    • key: string

      The key prefix to search for.

    Returns BlackboardEntry[]

removeValue

  • Removes the value stored under the specified key.

    Parameters

    • key: string

    Returns void

setValue

  • Stores the provided value under the specified key.

    Parameters

    • key: string
    • value: unknown

    Returns void

Generated using TypeDoc