Zum Hauptinhalt springen

AwaitLockshareRequest

Class Description

Use the Realtime API to subscript to Lockshare Requests. When a request was filed via RequestLockshare, it can be approved or revoked using ReplyLockshare. This Process is Realtime API exclusive.

RPC Configuration​

Rpc Name:​

Plain: AwaitLockshareRequest
Sha1: 43e1c8add4201052103ec2355959e4a85fc188a3
Rpc Call

RPCs can be called by their plain name or their SHA1 representation.

Rpc Parameters:​

"building_id" : int
Parameter Description

No-Op: This runs only on Websockets.

Requires Login:​

true

Requires Context:​

Context

The context providing parameter can either be a contagt-id (8-Bytes, Alphaumeric) or an integer as a building id. The context parameter name should make the choice obviouse, the type has not to be defined manually.

true

Requires contextParamName:​

building_id

Has Named Parameters:​

false

Requires WriteAccess:​

WriteAccess

Only accounts that have an explicit write access to the defined context can execute this RPC, no matter if the authentication level matches or not.

true

Requires AuthenticationLevel:​

Context

Authentication levels allow the SuperUser to define a by-RPC granular access configuration. If RPCs are chained in a single unified call and lenient is enabled, all allowed RPCs will be executed, while execution will fail entirely with lenient set to false.

STANDARD_USER

Requires Subbuilding Merge Strategy:​

SUBBUILDING_ONLY

Cache Configuration​

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:​

false

Realtime API​

This RPC is applicable to the Realtime API. You can subscribe to events that reflect in a response to your request.