RemoteSystemSessionInvitation
RemoteSystemSessionInvitation
RemoteSystemSessionInvitation
RemoteSystemSessionInvitation
Class
Definition
Represents an invitation from a session participant to join their remote session.
public : sealed class RemoteSystemSessionInvitation : IRemoteSystemSessionInvitationpublic sealed class RemoteSystemSessionInvitation : IRemoteSystemSessionInvitationPublic NotInheritable Class RemoteSystemSessionInvitation Implements IRemoteSystemSessionInvitation// 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)
|
Examples
See the following code for an example of how to receive and handle remote session invitations.
public void SubscribeAndHandleInvites() {
var invitationListener = new RemoteSystemSessionInvitationListener();
// register the following code to handle this event:
invitationListener.InvitationReceived += async (sender, args) => {
// issue a join request to the session
RemoteSystemSessionJoinResult joinResult = await args.Invitation.RemoteSystemSessionInfo.JoinAsync();
// handle the join result as in the normal session discovery scenario
// ...
};
}
Remarks
An instance of this class is contained in the RemoteSystemSessionInvitationReceivedEventArgs object that was passed in with the RemoteSystemSessionInvitationListener.InvitationReceived event.
The device receiving an invitation will need to use a RemoteSystemSessionInvitationListener to handle it.
Properties
Sender Sender Sender Sender
Gets a RemoteSystem object representing the device that sent the invitation.
public : RemoteSystem Sender { get; }public RemoteSystem Sender { get; }Public ReadOnly Property Sender As RemoteSystem// You can use this property in JavaScript.
The RemoteSystem object representing the sending device.
SessionInfo SessionInfo SessionInfo SessionInfo
Gets a RemoteSystemSessionInfo object representing the session to which this device was invited.
public : RemoteSystemSessionInfo SessionInfo { get; }public RemoteSystemSessionInfo SessionInfo { get; }Public ReadOnly Property SessionInfo As RemoteSystemSessionInfo// You can use this property in JavaScript.
- Value
- RemoteSystemSessionInfo RemoteSystemSessionInfo RemoteSystemSessionInfo RemoteSystemSessionInfo
The RemoteSystemSessionInfo object representing the session to which this device was invited.