AppBroadcastHeartbeatRequestedEventArgs
AppBroadcastHeartbeatRequestedEventArgs
AppBroadcastHeartbeatRequestedEventArgs
AppBroadcastHeartbeatRequestedEventArgs
Class
Definition
Provides data for the AppBroadcastBackgroundService.HeartbeatRequested event which is raised by the system periodically to confirm that the broadcasting background task is currently active.
Note
This API requires the appBroadcast and appBroadcastSettings capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime.
public : sealed class AppBroadcastHeartbeatRequestedEventArgs : IAppBroadcastHeartbeatRequestedEventArgspublic sealed class AppBroadcastHeartbeatRequestedEventArgs : IAppBroadcastHeartbeatRequestedEventArgsPublic NotInheritable Class AppBroadcastHeartbeatRequestedEventArgs Implements IAppBroadcastHeartbeatRequestedEventArgs// You can use this class in JavaScript.
- Attributes
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Remarks
In the handler for the HeartbeatRequested event, set the Handled property to true to confirm that the broadcasting background task is currently active.
Properties
Handled Handled Handled Handled
Gets or sets a value indicating whether the broadcasting background task is currently active.
public : PlatForm::Boolean Handled { get; set; }public bool Handled { get; set; }Public ReadWrite Property Handled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the broadcasting background task is currently active; otherwise, false.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.15063.0)
|
| API contract |
Windows.Media.Capture.AppBroadcastContract (introduced v1)
|
| Capabilities |
appBroadcastSettings
appBroadcast
|
Remarks
Set this value to true in the handler for the HeartbeatRequested event to confirm that the broadcasting background task is currently active.