RemoteSystemSessionInvitation RemoteSystemSessionInvitation RemoteSystemSessionInvitation RemoteSystemSessionInvitation RemoteSystemSessionInvitation Class

Definition

Represents an invitation from a session participant to join their remote session.

public : sealed class RemoteSystemSessionInvitation
struct winrt::Windows::System::RemoteSystems::RemoteSystemSessionInvitation
public sealed class RemoteSystemSessionInvitation
Public NotInheritable Class RemoteSystemSessionInvitation
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)
Capabilities
remoteSystem

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 Sender

Gets a RemoteSystem object representing the device that sent the invitation.

SessionInfo SessionInfo SessionInfo SessionInfo SessionInfo

Gets a RemoteSystemSessionInfo object representing the session to which this device was invited.