API. UAS

The API.UAS namespace provides a set of interfaces for User Administration Service (UAS) management.

Source

Members

(static, readonly) this.USERGRANTLIST :string

Enum for all user grants

Type:
  • string
Properties
NameTypeDescription
UAS_CFG_WRITEstring
UAS_BACKUPstring
UAS_CALIBRATEstring
UAS_CONTROLLER_PROPERTIES_WRITEstring
UAS_EVENTLOG_CLEARstring
UAS_FILE_ACCESS_READstring
UAS_FILE_ACCESS_READ_WRITEstring
UAS_IO_WRITEstring
UAS_REMOTE_WARMSTARTstring
UAS_RESTOREstring
UAS_RAPID_EDITstring
UAS_RAPID_LOADPROGRAMstring
UAS_RAPID_MODPOSstring
UAS_RAPID_EXECUTEstring
UAS_RAPID_DEBUGstring
UAS_SYSTEM_ADMINISTRATIONstring
UAS_SPEED_DECREASEstring
UAS_RAPID_CURRVALUEstring
UAS_REVOLUTION_COUNTER_UPDATEstring
UAS_SYSUPDATEstring
UAS_REMOTE_LOGINstring
UAS_NETWORK_SECURITYstring
UAS_REMOTE_MOUNT_FILE_ACCESS_READ_WRITEstring
UAS_REMOTE_START_STOP_IN_AUTOstring
UAS_FTP_READstring
UAS_FTP_WRITEstring
UAS_LOCK_SAFETY_CONFIGstring
UAS_SAFETY_SERVICESstring
UAS_SAFETY_SYNCHRONIZATIONstring
UAS_KL_MODE_SELECTORstring
UAS_SAFETY_COMMISSIONING_MODEstring
UAS_REMOTE_MOUNT_FILE_ACCESS_READstring
UAS_APPL_KEY_FP_AUTO_LOGOFFstring
UAS_UAS_ADMINISTRATIONstring
UAS_DETACH_FLEXPENDANTstring
Source

(readonly) GRANTSTATES :number

Functions that grant state.

Type:
  • number
Properties
NameTypeDescription
NOT_GRANTEDnumber
GRANTEDnumber
Source

(readonly) GRANTTYPES :number

Functions that have grant requirements.

Type:
  • number
Properties
NameTypeDescription
loadModulenumber
deploynumber
updatePositionnumber
ioWritenumber
editRAPIDnumber
executeProgramnumber
Source

Methods

getUserGrants() → {Promise.<Array.<string>>}

Gets the user grants.

Source
Returns:
Type: 
Promise.<Array.<string>>
Example
await API.UAS.getUserGrants()

hasSpecificGrants(typeopt) → {Promise.<boolean>}

Checks whether the logged in user has function-required grants.

Parameters:
NameTypeAttributesDescription
typeAPI.UAS.GRANTTYPES<optional>

Funciton types.

Source
Returns:
Type: 
Promise.<boolean>
Example
await API.UAS.hasSpecificGrants(API.UAS.GRANTTYPES.loadModule)