From Bright Pattern Documentation
(Created new topic from branched topic Documentation:ServicePattern:desktop-javascript-api-specification:Callback:5.1) |
(Updated via BpDeleteTranslateTags script) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | = Callback= | |
| − | + | The function that is called upon completion of the call/screen recording methods. | |
== Syntax == | == Syntax == | ||
| − | + | callback = function(data) { | |
| + | data.recording = 1/0; | ||
| + | data.muted = 1/0; | ||
| + | data.paused = 1/0; | ||
| + | } | ||
| − | '' | + | === Parameters === |
| − | + | {|border="1" style="border-collapse:collapse" cellpadding="5" | |
| − | '' | + | | '''Parameter''' |
| − | + | | '''Type''' | |
| − | '' | + | | '''Description''' |
| − | + | | '''Example''' | |
| − | '' | + | |- |
| − | + | | data.recording | |
| − | + | | Boolean | |
| − | + | | Indicates if voice/screen recording is currently in progress; note that voice recording is applied to interactions (calls), while screen recording is applied to user sessions | |
| − | + | | "1" (for true; recording is on) | |
| − | + | |- | |
| − | + | | data.muted | |
| − | + | | Boolean | |
| − | + | | Indicates if voice recording is currently muted; returned only for the voice recording methods | |
| − | + | | "0" (for false; recording is not muted) | |
| − | + | |- | |
| − | + | | data.paused | |
| − | + | | Boolean | |
| + | | Indicates if screen recording is currently paused; returned only for the screen recording methods | ||
| + | | "1" (for false, recording is not paused) | ||
| + | |} | ||
Latest revision as of 04:31, 29 May 2024
Callback
The function that is called upon completion of the call/screen recording methods.
Syntax
callback = function(data) {
data.recording = 1/0;
data.muted = 1/0;
data.paused = 1/0;
}
Parameters
| Parameter | Type | Description | Example |
| data.recording | Boolean | Indicates if voice/screen recording is currently in progress; note that voice recording is applied to interactions (calls), while screen recording is applied to user sessions | "1" (for true; recording is on) |
| data.muted | Boolean | Indicates if voice recording is currently muted; returned only for the voice recording methods | "0" (for false; recording is not muted) |
| data.paused | Boolean | Indicates if screen recording is currently paused; returned only for the screen recording methods | "1" (for false, recording is not paused) |