Contents

Method

GetRemote

ModuleStorage
LibraryCore
Action

Retrieve the requested datum directly from the Platform central repository.

Parameters

Name (string): The key of the datum to retrieve. Case is significant.

TimeoutSecs (integer; optional, default 60): If the operation has not completed within the specified time period, it will fail with an error.

Return valuesValue (table): Contents of the value retrieved as a string, which may be empty, either because the value is empty or because the key does not exist.
Example
@token = Storage.GetRemote(Name: "Api.Token");
Platforms
  • Windows
  • Linux
  • MacOS
Notes

It is not an error if the datum named by the key does not exist, but an empty result is returned.

This method does not return a value in TIMS because it requires a Tachyon Switch.

See User Defined Persistent Storage page for guidance using persistent storage tables.

The following methods exist in the Agent Storage module:

  • Page:
    Storage.Check — Tests the existence of a user defined persistent storage table.
  • Page:
    Storage.Delete — Removes an existing user defined persistent storage table.
  • Page:
    Storage.Get — Indicate whether a persistent storage table of the specified name is present and return its contents if present.
  • Page:
    Storage.GetRemote — Retrieve the requested datum directly from the Platform central repository.
  • Page:
    Storage.List — Enumerates all user-defined persistent storage tables.
  • Page:
    Storage.Set — Set or change the value of the named persistent storage table.

New in v8.0.