Unsubscribe

Class Description

This is a PLaceholder RPC and does virtually nothing. It is here to make sure that there is no other RPC that creates a conflicting name. This Method can only be used via the Realtime-API and is used to unsubscribe from existing subscriptions, without disconnecting from the service.

RPC Configuration

Rpc Name:

Plain: Unsubscribe
Sha1: dcedcc0d16336d9d8bd50cab494dd0f3994ff306

Rpc Call

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

Rpc Parameters:

"subscription_handle" : string 

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.

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.

false

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:

REPLACE

Cache Configuration

Response Cache

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

Cache enabled:

true

Cache Time to Live:

60

Realtime API

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