Events
Events that can be registered for callbacks via registerEventListener.
onVdaSessionSize
Event Type to register callback to receive vda session size on session resize.
Type
-
String
onDisplayDetailsChanged
Event type to register callback to receive display details on session resize.
Type
-
String
onLockStateChanged
Event type to register callback to receive lock state on lock state change.
Type
-
String
Example
// This is the example callback function thirdparty needs to implement
function lockStateChangeCallback(lockStateJson) {
console.log("screen lock state = ",
lockStateJson.lockState);
if (lockStateJson.lockState ===
citrix.receiver.constants.lockState.LOCKED) {
console.log("Device is Locked");
// Handle Device locked
} else if (lockStateJson.lockState ===
citrix.receiver.constants.lockState.UNLOCKED) {
console.log("Device is Unlocked");
// Handle Device unlocked
}
}
// Step1: check capability
let caps = await citrix.receiver.getCapabilities();
// Step 2: if capability is available register
onLockStateChange
if (caps.lockStateEvent) {
let returnPromise =
citrix.receiver.registerEventListener("onLockStateChange", lockStateChangeCallback);
if (returnPromise) {
let returnValue = await returnPromise;
let returnCode = returnValue.returnCode;
if (returnCode ===
citrix.receiver.constants.returnCode.SUCCESS) {
console.log("callback on 'onLockStateChange'
event is successfully registered");
} else {
// Handle failed to register for event
'onLockStateChange'
}
} else {
// Handle failed to register for event
'onLockStateChange'
}
}