{"type":"doc","content":[{"type":"layoutSection","marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"registry ","type":"text","marks":[{"type":"em"}]},{"text":"object allows you to read from and write to the player registry (i.e. the persistent memory). The registry consists of named registry sections, and each registry section contains entries (key/value pairs).","type":"text"}]},{"type":"paragraph","content":[{"text":"registry IDL","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"interface Registry {\n Promise read(String sectionName, String key);\n Promise read(String sectionName);\n Promise read();\n\n Promise write(String sectionName, String key, String value);\n Promise write(String sectionName, RegistrySection section);\n Promise write(RegistryObject);\n\n Promise flush();\n};","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"panel","parameters":{"macroParams":{"borderColor":{"value":"#3D3D3D"},"bgColor":{"value":"#F4F4F4"},"titleColor":{"value":"#3D3D3D"},"borderWidth":{"value":"0"},"titleBGColor":{"value":"#3D3D3D"},"borderStyle":{"value":"solid"}},"macroMetadata":{"macroId":{"value":"6041596c-97c4-48dc-8f94-eb2b1d949b1e"},"schemaVersion":{"value":"1"},"title":"Panel"}},"localId":"b4a5443c-2ab5-4ec0-897f-bf36dbff20ed"},"content":[{"type":"paragraph","content":[{"text":"ON THIS PAGE","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"indent":{"value":"20px"}},"macroMetadata":{"macroId":{"value":"c50aefcd-c5d8-4997-843b-7119416200bb"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"1a61c169-b4cd-4547-b273-ea3361002455"}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Object Creation","type":"text"}]},{"type":"paragraph","content":[{"text":"To create a ","type":"text"},{"text":"registry","type":"text","marks":[{"type":"em"}]},{"text":" object, first load the ","type":"text"},{"text":"brightsign/registry","type":"text","marks":[{"type":"code"}]},{"text":" module using the ","type":"text"},{"text":"require()","type":"text","marks":[{"type":"code"}]},{"text":" method. Then create an instance of the ","type":"text"},{"text":"registry","type":"text","marks":[{"type":"em"}]},{"text":" class.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"var registryClass = require(\"@brightsign/registry\");\nvar registry = new registryClass();","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Registry","type":"text"}]},{"type":"paragraph","content":[{"text":"Use this interface for registry read/write operations. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"All section and key names are canonicalized to lowercase. ","type":"text"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"read()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise read(String sectionName, String key)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the string registry value associated with the specified key. You must also specify the registry section where the key is stored.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise read(String sectionName)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the specified registry section in the following format: ","type":"text"},{"text":"RegistrySection.{entry_key}","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise read()","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns all registry sections in the following format: ","type":"text"},{"text":"RegistryObject.{section_name}.{entry_key}","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"write()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise write(String sectionName, String key, String value)","type":"text"}]},{"type":"paragraph","content":[{"text":"Writes a single registry entry to the specified registry section. ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise write(String sectionName, RegistrySection section)","type":"text"}]},{"type":"paragraph","content":[{"text":"Writes the specified registry section to the registry. If the registry section does not exist, it will be created; otherwise, the entries will be added or updated in the existing registry section (preexisting registry entries that are not specified in the write operation will be unaffected).","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise write(RegistryObject)","type":"text"}]},{"type":"paragraph","content":[{"text":"Writes the specified registry sections/entries to the registry. Registry sections and entries that do not exist will be created, and existing entries will be updated (preexisting registry sections/entries that are not specified in the write operation will be unaffected).","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The single-entry ","type":"text"},{"text":"write()","type":"text","marks":[{"type":"code"}]},{"text":" method will not perform well when used to write multiple entries successively. For optimal performance, use the single-section ","type":"text"},{"text":"write()","type":"text","marks":[{"type":"code"}]},{"text":" method to write multiple entries to a single section and the full-registry method to write to multiple sections.","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Sixty seconds at most after a write to the registry, or before an orderly reboot, the newly written data will be automatically be written out to persistent storage. If for some reason, a set of registry changes must be written immediately, then the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"flush()","type":"text","marks":[{"type":"code"}]},{"text":" method should be called after the last one.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"panel","attrs":{"panelType":"error"},"content":[{"type":"paragraph","content":[{"text":"Important","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"While it is possible to read the entire registry, modfiy the return value, and write it back into the registry, this is not a recommended practice: It may cause race conditions among different parts of the system that are attempting to write to the registry at the same time.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"flush()","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise flush()","type":"text"}]},{"type":"paragraph","content":[{"text":"Flushes the contents of the registry immediately to persistent storage.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"type":"hardBreak"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Tip","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"To delete a registry entry or section, assign it a ","type":"text"},{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":" value.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"var registryClass = require(\"@brightsign/registry\");\nvar registry = new registryClass();\n \n//Reads the entire registry to the log.\nregistry.read().then(function(registry) {\n console.log(JSON.stringify(registry));\n});\n \n//Reads the contents of the \"networking\" registry to the log.\nregistry.read(\"networking\").then(\n\tfunction(registry){console.log(JSON.stringify(registry));});\n \n//Writes multiple entries to multiple sections.\nregistry.write({networking:{ssh:\"22\", http_server:\"8080\"}, autorun:{devicesetupcomplete:\"1\"}} ).then(\n\tfunction(){console.log(\"Write Successful\");});\n \n//Updates a single section.\nregistry.write(\"networking\", {ssh:\"22\", http_server:\"8080\"}).then(\n\tfunction(){console.log(\"Write Successful\");});\n \n//Deletes a registry section and entry, and creates a new section.\nregistry.write({networking:{ssh:\"22\", http_server:null}, autorun:null, section1:{test:\"val\"}} ).then(\n\tfunction(){console.log(\"Write Successful\");});","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported