Skip to content

Interface: RTURecieptPolicy()

Describes the function which is used to determine if a user has permission to access a resource

Remarks

This is used to determine if a user can receive an RTU message for the specified instance

ts
RTURecieptPolicy(
   user: any,
   model: string,
   uid: string,
   instance: LucidRow):
  | boolean
| Promise<boolean>;

Describes the function which is used to determine if a user has permission to access a resource

Parameters

ParameterTypeDescription
useranyThe instance of the user resolved by the AccessTokensGuard
modelstringThe stringified name of the model which is being accessed
uidstringThe unique identifier of the instance which is being accessed
instanceLucidRowThe instance of the model which is being accessed

Returns

| boolean | Promise<boolean>

Remarks

This is used to determine if a user can receive an RTU message for the specified instance