ControlChannelTrigger Constructors

  • Reference

Definition

Namespace:
Windows.Networking.Sockets

Overloads

ControlChannelTrigger(String, UInt32)

Creates a new ControlChannelTrigger object with a control channel trigger ID and a value for the server keep-alive interval.

Note

The ControlChannelTrigger class is not supported on Windows Phone.
ControlChannelTrigger(String, UInt32, ControlChannelTriggerResourceType)

Creates a new ControlChannelTrigger object with a control channel trigger ID, a value for the server keep-alive interval, and the resource type requested for the control channel trigger.

Note

The ControlChannelTrigger class is not supported on Windows Phone.

ControlChannelTrigger(String, UInt32)

Edit

Creates a new ControlChannelTrigger object with a control channel trigger ID and a value for the server keep-alive interval.

Note

The ControlChannelTrigger class is not supported on Windows Phone.

public:
 ControlChannelTrigger(Platform::String ^ channelId, unsigned int serverKeepAliveIntervalInMinutes);
 ControlChannelTrigger(winrt::hstring const& channelId, uint32_t const& serverKeepAliveIntervalInMinutes);
public ControlChannelTrigger(string channelId, uint serverKeepAliveIntervalInMinutes);
function ControlChannelTrigger(channelId, serverKeepAliveIntervalInMinutes)
Public Sub New (channelId As String, serverKeepAliveIntervalInMinutes As UInteger)

Parameters

channelId
String

Platform::String

winrt::hstring

A string used to differentiate various control channel triggers on the local computer. The maximum length allowed for this string is 64 characters.

serverKeepAliveIntervalInMinutes
UInt32

unsigned int

uint32_t

The keep-alive interval, in minutes, registered with the system to indicate when the app and network connections used should wake up.

The minimum value that can be set for this parameter is 15 minutes. The maximum value that can be set is 1439 minutes (approximately 24 hours).

Remarks

The [ControlChannelTrigger(String, UInt32) constructor creates a ControlChannelTrigger object. By default, the resource type requested for the control channel trigger is a ControlChannelTriggerResourceType set to RequestSoftwareSlot.

If an app needs a hardware slot to support connected standby, then the ControlChannelTrigger(String, UInt32, ControlChannelTriggerResourceType) constructor should be used to create the ControlChannelTrigger object since this allows an app to specific the requested resource type.

See also

Applies to

ControlChannelTrigger(String, UInt32, ControlChannelTriggerResourceType)

Edit

Creates a new ControlChannelTrigger object with a control channel trigger ID, a value for the server keep-alive interval, and the resource type requested for the control channel trigger.

Note

The ControlChannelTrigger class is not supported on Windows Phone.

public:
 ControlChannelTrigger(Platform::String ^ channelId, unsigned int serverKeepAliveIntervalInMinutes, ControlChannelTriggerResourceType resourceRequestType);
 ControlChannelTrigger(winrt::hstring const& channelId, uint32_t const& serverKeepAliveIntervalInMinutes, ControlChannelTriggerResourceType const& resourceRequestType);
public ControlChannelTrigger(string channelId, uint serverKeepAliveIntervalInMinutes, ControlChannelTriggerResourceType resourceRequestType);
function ControlChannelTrigger(channelId, serverKeepAliveIntervalInMinutes, resourceRequestType)
Public Sub New (channelId As String, serverKeepAliveIntervalInMinutes As UInteger, resourceRequestType As ControlChannelTriggerResourceType)

Parameters

channelId
String

Platform::String

winrt::hstring

A string used to differentiate various control channel triggers on the local computer. The maximum length allowed for this string is 64 characters.

serverKeepAliveIntervalInMinutes
UInt32

unsigned int

uint32_t

The keep-alive interval, in minutes, registered with the system to indicate when the app and network connections used should wake up.

The minimum value that can be set for this parameter is 15 minutes. The maximum value that can be set is 1439 minutes (approximately 24 hours).

resourceRequestType
ControlChannelTriggerResourceType

The resource type requested for the control channel trigger.

Remarks

The [ControlChannelTrigger(String, UInt32, ControlChannelTriggerResourceType) constructor allows an app to create a ControlChannelTrigger object with a specific the resource type requested for the control channel trigger. If an app needs a hardware slot to support connected standby, then the resourceRequestType should be set to RequestHardwareSlot.

See also

Applies to