SocketActivityTrigger SocketActivityTrigger SocketActivityTrigger SocketActivityTrigger Class

Definition

Namespace:
Windows.ApplicationModel.Background Windows.ApplicationModel.Background Windows.ApplicationModel.Background Windows.ApplicationModel.Background
Edit

Represents a trigger that launches a background task for handling socket activity.

public : sealed class SocketActivityTrigger : IBackgroundTrigger, ISocketActivityTriggerpublic sealed class SocketActivityTrigger : IBackgroundTrigger, ISocketActivityTriggerPublic NotInheritable Class SocketActivityTrigger Implements IBackgroundTrigger, ISocketActivityTrigger// You can use this class in JavaScript.
Attributes
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

For information about how to use this event and the socket broker with your app, see Network communications in the background.

Constructors

SocketActivityTrigger() SocketActivityTrigger() SocketActivityTrigger() SocketActivityTrigger()

Edit

Initializes a new instance of a socket activity trigger.

public : SocketActivityTrigger()public SocketActivityTrigger()Public Sub New()// You can use this method in JavaScript.

Properties

IsWakeFromLowPowerSupported IsWakeFromLowPowerSupported IsWakeFromLowPowerSupported IsWakeFromLowPowerSupported

Edit

Gets whether a SocketActivityTrigger can wake the machine from a low power state.

public : PlatForm::Boolean IsWakeFromLowPowerSupported { get; }public bool IsWakeFromLowPowerSupported { get; }Public ReadOnly Property IsWakeFromLowPowerSupported As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True indicates that this trigger can wake the machine from a low power state; false otherwise.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

This trigger is registered such that when there is new data available on the socket it will wake the device and activate the background task. On devices that don't support always on, always connected (AOAC), the device will not be awakened to trigger the background task.

Devices that support AOAC can be put into standby mode without fully powering down. In this mode it can maintain network connectivity. On these devices, a trigger can wake up the device.

See Also