RemoteSystemSessionMessageChannel
RemoteSystemSessionMessageChannel
RemoteSystemSessionMessageChannel
RemoteSystemSessionMessageChannel
Class
Definition
Handles a dedicated data transfer channel within a remote session. This class owns the functionality for both sending and receiving.
public : sealed class RemoteSystemSessionMessageChannel : IRemoteSystemSessionMessageChannelpublic sealed class RemoteSystemSessionMessageChannel : IRemoteSystemSessionMessageChannelPublic NotInheritable Class RemoteSystemSessionMessageChannel Implements IRemoteSystemSessionMessageChannel// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Remarks
Messages are sent and received over this channel asynchronously, so the chronological ordering of messages is not guaranteed.
Constructors
RemoteSystemSessionMessageChannel(RemoteSystemSession, String) RemoteSystemSessionMessageChannel(RemoteSystemSession, String) RemoteSystemSessionMessageChannel(RemoteSystemSession, String) RemoteSystemSessionMessageChannel(RemoteSystemSession, String)
Initializes an instance of RemoteSystemSessionMessageChannel to manage messaging for a given remote session
public : RemoteSystemSessionMessageChannel(RemoteSystemSession session, PlatForm::String channelName)public RemoteSystemSessionMessageChannel(RemoteSystemSession session, String channelName)Public Sub New(session As RemoteSystemSession, channelName As String)// You can use this method in JavaScript.
The RemoteSystemSession to which this messaging channel will correspond.
- channelName
- PlatForm::String String String String
The user-defined name of the messaging channel. It should be simple and descriptive, such as "Bob's 3D App session."
RemoteSystemSessionMessageChannel(RemoteSystemSession, String, RemoteSystemSessionMessageChannelReliability) RemoteSystemSessionMessageChannel(RemoteSystemSession, String, RemoteSystemSessionMessageChannelReliability) RemoteSystemSessionMessageChannel(RemoteSystemSession, String, RemoteSystemSessionMessageChannelReliability) RemoteSystemSessionMessageChannel(RemoteSystemSession, String, RemoteSystemSessionMessageChannelReliability)
Initializes an instance of RemoteSystemSessionMessageChannel to manage messaging for a given remote session, specifying the reliability type of the channel.
public : RemoteSystemSessionMessageChannel(RemoteSystemSession session, PlatForm::String channelName, RemoteSystemSessionMessageChannelReliability reliability)public RemoteSystemSessionMessageChannel(RemoteSystemSession session, String channelName, RemoteSystemSessionMessageChannelReliability reliability)Public Sub New(session As RemoteSystemSession, channelName As String, reliability As RemoteSystemSessionMessageChannelReliability)// You can use this method in JavaScript.
The RemoteSystemSession to which this messaging channel will correspond.
- channelName
- PlatForm::String String String String
The user-defined name of the messaging channel. It should be simple and descriptive, such as "Bob's 3D App messaging channel."
- reliability
- RemoteSystemSessionMessageChannelReliability RemoteSystemSessionMessageChannelReliability RemoteSystemSessionMessageChannelReliability RemoteSystemSessionMessageChannelReliability
A RemoteSystemSessionMessageChannelReliability value describing the reliability type of this channel.
Properties
Session Session Session Session
Gets the remote session to which this messaging channel corresponds.
public : RemoteSystemSession Session { get; }public RemoteSystemSession Session { get; }Public ReadOnly Property Session As RemoteSystemSession// You can use this property in JavaScript.
A RemoteSystemSession object representing the remote session.
Methods
BroadcastValueSetAsync(ValueSet) BroadcastValueSetAsync(ValueSet) BroadcastValueSetAsync(ValueSet) BroadcastValueSetAsync(ValueSet)
Sends a message to all participants in this remote session messaging channel.
public : IAsyncOperation<PlatForm::Boolean> BroadcastValueSetAsync(ValueSet messageData)public IAsyncOperation<bool> BroadcastValueSetAsync(ValueSet messageData)Public Function BroadcastValueSetAsync(messageData As ValueSet) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
A ValueSet object containing the data to be sent to all participants in the channel.
An asynchronous operation containing a boolean value: true if the send operation was a success, otherwise false.
SendValueSetAsync(ValueSet, RemoteSystemSessionParticipant) SendValueSetAsync(ValueSet, RemoteSystemSessionParticipant) SendValueSetAsync(ValueSet, RemoteSystemSessionParticipant) SendValueSetAsync(ValueSet, RemoteSystemSessionParticipant)
Sends a message to a participant in this remote session messaging channel.
public : IAsyncOperation<PlatForm::Boolean> SendValueSetAsync(ValueSet messageData, RemoteSystemSessionParticipant participant)public IAsyncOperation<bool> SendValueSetAsync(ValueSet messageData, RemoteSystemSessionParticipant participant)Public Function SendValueSetAsync(messageData As ValueSet, participant As RemoteSystemSessionParticipant) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
A ValueSet object containing the data to be sent to the specified participant.
- participant
- RemoteSystemSessionParticipant RemoteSystemSessionParticipant RemoteSystemSessionParticipant RemoteSystemSessionParticipant
A RemoteSystemSessionParticipant object corresponding to the participant to which the message should be sent.
An asynchronous operation containing a boolean value: true if the send operation was a success, otherwise false.
SendValueSetToParticipantsAsync(ValueSet, IIterable)
SendValueSetToParticipantsAsync(ValueSet, IIterable)
SendValueSetToParticipantsAsync(ValueSet, IIterable)
SendValueSetToParticipantsAsync(ValueSet, IIterable)
Sends a message to a specified set participants in this remote session messaging channel.
public : IAsyncOperation<PlatForm::Boolean> SendValueSetToParticipantsAsync(ValueSet messageData, IIterable<RemoteSystemSessionParticipant> participants)public IAsyncOperation<bool> SendValueSetToParticipantsAsync(ValueSet messageData, IEnumerable<RemoteSystemSessionParticipant> participants)Public Function SendValueSetToParticipantsAsync(messageData As ValueSet, participants As IEnumerable<RemoteSystemSessionParticipant>) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
A ValueSet object containing the data to be sent to the specified participants.
- participants
- IIterable<RemoteSystemSessionParticipant> IEnumerable<RemoteSystemSessionParticipant> IEnumerable<RemoteSystemSessionParticipant> IEnumerable<RemoteSystemSessionParticipant>
An iterable collection of RemoteSystemSessionParticipant objects corresponding to the participants to which the message should be sent.
An asynchronous operation containing a boolean value: true if the send operation was a success, otherwise false.
Events
ValueSetReceived ValueSetReceived ValueSetReceived ValueSetReceived
Raised when a message (in the form of a key-value pair) is received by the channel. The contents of the message are contained by the RemoteSystemSessionValueSetReceivedEventArgs object that is passed in.
public : event TypedEventHandler ValueSetReceived<RemoteSystemSessionMessageChannel, RemoteSystemSessionValueSetReceivedEventArgs>public event TypedEventHandler ValueSetReceived<RemoteSystemSessionMessageChannel, RemoteSystemSessionValueSetReceivedEventArgs>Public Event ValueSetReceived<RemoteSystemSessionMessageChannel, RemoteSystemSessionValueSetReceivedEventArgs>// You can use this event in JavaScript.