RemoteSystemSessionCreationResult RemoteSystemSessionCreationResult RemoteSystemSessionCreationResult RemoteSystemSessionCreationResult Class

Definition

Represents the result of an attempt by a RemoteSystemSessionController object to create a new remote session.

public : sealed class RemoteSystemSessionCreationResult : IRemoteSystemSessionCreationResultpublic sealed class RemoteSystemSessionCreationResult : IRemoteSystemSessionCreationResultPublic NotInheritable Class RemoteSystemSessionCreationResult Implements IRemoteSystemSessionCreationResult// You can use this class in JavaScript.
Attributes
Windows 10 requirements
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 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 == RemoteSystemSessionCreateStatus.Success) {
        // creation was successful
        RemoteSystemSession currentSession = createResult.RemoteSystemSession;

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

        // Use session ...

    } else if (createResult.Status == RemoteSystemSessionCreateStatus.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
    }
}

Properties

Session Session Session Session

Gets the RemoteSystemSession object related to this creation attempt.

public : RemoteSystemSession Session { get; }public RemoteSystemSession Session { get; }Public ReadOnly Property Session As RemoteSystemSession// You can use this property in JavaScript.
Value
RemoteSystemSession RemoteSystemSession RemoteSystemSession RemoteSystemSession

The RemoteSystemSession object representing the session that was created (if the attempt was successful). If the session was not created successfully, this value is null.

Status Status Status Status

Gets the status of a RemoteSystemSessionController object's attempt to create a remote session.

public : RemoteSystemSessionCreationStatus Status { get; }public RemoteSystemSessionCreationStatus Status { get; }Public ReadOnly Property Status As RemoteSystemSessionCreationStatus// You can use this property in JavaScript.