RemoteSystemSessionJoinRequestedEventArgs Class

Definition

Namespace:

Windows.System.RemoteSystems

Contains information about the RemoteSystemSessionController.JoinRequested event that was raised.

public ref class RemoteSystemSessionJoinRequestedEventArgs sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class RemoteSystemSessionJoinRequestedEventArgs final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class RemoteSystemSessionJoinRequestedEventArgs

Public NotInheritable Class RemoteSystemSessionJoinRequestedEventArgs

Inheritance

Object Platform::Object IInspectable RemoteSystemSessionJoinRequestedEventArgs

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v4.0)
App capabilities	remoteSystem

Examples

See the following code for an example of how to create a remote session and handle join requests.

public async void StartNewSharedExperience() {

    var manager = new RemoteSystemSessionController("Bob’s Minecraft game");

    // register the following code to handle the JoinRequested event
    manager.JoinRequested += async (sender, args) => {
        // Get the deferral
        var deferral = args.GetDeferral();

        // display the participant (args.JoinRequest.Participant) on UI, giving the 
        // user an opportunity to respond
        // ...

        // If the user chooses "accept", accept this remote system as a participant
        args.JoinRequest.Accept();
    };

    // create and start the session
    RemoteSystemSessionCreationResult createResult = await manager.CreateSessionAsync();

    // handle the creation result
    if (createResult.Status == RemoteSystemSessionCreationStatus.Success) {
        // creation was successful
        RemoteSystemSession currentSession = createResult.Session;

        // optionally subscribe to the disconnection event
        currentSession.Disconnected += async (sender, args) => {
            // update the UI, using args.Reason
            // ...
        };

        // Use session ...

    } else if (createResult.Status == RemoteSystemSessionCreationStatus.SessionLimitsExceeded) {
        // creation failed. Optionally update UI to indicate that there are too many sessions in progress
    } else {
        // creation failed for an unknown reason. Optionally update UI
    }
}

Remarks

This class is instantiated whenever the RemoteSystemSessionController.JoinRequested event is raised, and it should be handled by the method(s) registered to this event.

Properties

JoinRequest

Gets the RemoteSystemSessionJoinRequest that represents this incoming request.

Methods

GetDeferral()

Gets a deferral object for this operation.