collectionproxy

The collection should be loaded by the collection proxy. Setting the collection to "nil" will revert it back to the original collection. The collection proxy shouldn't be loaded and should have the 'Exclude' checkbox checked. This functionality is designed to simplify the management of Live Update resources.

// The example assumes the script belongs to an instance with a
// collection-proxy-component with id "proxy".
const [ok, error] = collectionproxy.set_collection("/go#collectionproxy", "/LU/3.collectionc");
if (ok) {
  print("The collection has been changed to /LU/3.collectionc");
} else {
  print("Error changing collection to /LU/3.collectionc ", error);
}
msg.post("/go#collectionproxy", "load");
msg.post("/go#collectionproxy", "init");
msg.post("/go#collectionproxy", "enable");

Parameters

• url?: string | Hash | Url — the collection proxy component
• prototype?: string | nil — the path to the new collection, or nil

Returns

• success: boolean — collection change was successful
• code: number — one of the collectionproxy.RESULT_* codes if unsuccessful

return an indexed table of resources for a collection proxy where the referenced collection has been excluded using LiveUpdate. Each entry is a hexadecimal string that represents the data of the specific resource. This representation corresponds with the filename for each individual resource that is exported when you bundle an application with LiveUpdate functionality.

function print_resources(self, cproxy) {
  const resources = collectionproxy.get_resources(cproxy);
  for (const v of resources) {
    print(`Resource: ${v}`);
  }
}

Parameters

• collectionproxy: Url — the collectionproxy to check for resources.

Returns

• resources: Record<string | number, unknown> — the resources, or an empty list if the collection was not excluded.

It's impossible to change the collection while the collection proxy is loading.

It's impossible to change the collection if the collection is already loaded.

It's impossible to change the collection for a proxy that isn't excluded.