Library
The purpose of the Library Cache is to load the global library, which is fairly static into memory, so that commonly reused items such as quantity types, units and parameters along with their translations can be quickly available. In addition there are helper methods to retrieve these items efficiently.
LibraryCache Class
- class ClientSDK.CacheHelper.LibraryCache
Methods
LoadAsync
Loads the library cache. After the library cache is loaded, the other methods will perform.
Required Role(s): Any
- ClientSDK.Spreadsheet.LoadAsync()
- Return type
Task<bool>
GetParameter - By GUID
Retrieves a parameter by GUID from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetParameter(string parameterId)
- Parameters
parameterId (string) – Unique Identifier (GUID).
- Return type
Parameter
GetParameter - By long Id
Retrieves a parameter by the long id from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetParameter(long parameterId)
- Parameters
parameterId (long) – Unique Identifier (long).
- Return type
Parameter
GetParameterByName
Retrieves a parameter by translated Name from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetParameterByName(string name)
- Parameters
name (string) – Translated name of the parameter.
- Return type
Parameter
GetParameterAgencyCodeType
Retrieves a Parameter Agency Code Type by GUID from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetParameterAgencyCodeType(string id)
- Parameters
id (string) – Unique Identifier (GUID).
- Return type
ParameterAgencyCodeType
GetQuantityType
Retrieves a quantity type by GUID from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetQuantityType(string quantityTypeId)
- Parameters
quantityTypeId (string) – Unique Identifier (GUID).
- Return type
QuantityType
GetQuantityTypeByName
Retrieves a quantity type by Name from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetQuantityTypeByName(string name)
- Parameters
name (string) – Display name of the quantity type.
- Return type
QuantityType
GetParameterAgencyCode
Retrieves a Parameter Agency Code by GUID from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetParameterAgencyCode(string id)
- Parameters
id (string) – Unique Identifier (GUID).
- Return type
ParameterAgencyCode
GetUnit - By GUID
Retrieves a unit by GUID from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetUnit(string unitId)
- Parameters
unitId (string) – Unique Identifier (GUID).
- Return type
Unit
GetUnit - By long Id
Retrieves a unit by the long id from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetUnit(long unitId)
- Parameters
unitId (long) – Unique Identifier (long).
- Return type
Unit
GetUnitByI18nKey
Retrieves a unit by I18nKey from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetUnitByI18nKey(string i18nKey)
- Parameters
i18nKey (string) – The i18n Key for the Unit.
- Return type
Unit
GetUnitByName
Retrieves a unit by translated Name from Cache.
Required Role(s): Any
- ClientSDK.Spreadsheet.GetUnitByName(string name)
- Parameters
name (string) – Translated name of the unit.
- Return type
Unit
ToString
Serializes Cache for local storage.
Required Role(s): Any
- ClientSDK.Spreadsheet.ToString()
- Return type
string
Properties
I18Nkeys
- ClientSDK.CacheHelper.LibraryCache.I18Nkeys
- Return type
List<I18NKey>
Parameters
- ClientSDK.CacheHelper.LibraryCache.Parameters
- Return type
List<Parameter>
ParameterAgencyCodes
- ClientSDK.CacheHelper.LibraryCache.ParameterAgencyCodes
- Return type
List<ParameterAgencyCode>
ParameterAgencyCodeTypes
- ClientSDK.CacheHelper.LibraryCache.ParameterAgencyCodeTypes
- Return type
List<ParameterAgencyCodeType>
QuantityTypes
- ClientSDK.CacheHelper.LibraryCache.QuantityTypes
- Return type
List<Unit>
Units
- ClientSDK.CacheHelper.LibraryCache.Units
- Return type
List<QuantityType>