Delete a session

Permanently delete a session to remove it from the system and disconnect all players.

Read time 1 minute

Last updated 3 months ago

Session hosts can delete their sessions. Deleted sessions are no longer accessible. Deleted sessions don't appear in queries and all APIs targeting a deleted session, for example, Get and Update, fail.

Note

The session is automatically deleted when the last player leaves the session.

Best practices

Clients should expect that they can be removed from a session at any time. Removal can happen due to the session being deleted, the player being removed from a session by the host, the player being removed from the session due to a relay disconnect, or a service outage. Clients should expect that all API calls targeting a specific session can fail, and should handle them accordingly.

Example code to delete a session

Delete a session by calling

DeleteAsync()

to remove the session from the backend service.


using Unity.Services.Multiplayer;using System.Threading.Tasks;using UnityEngine;// ...async Task DeleteSessionExampleAsync(ISession session){    // 1. Verify if the local player is the host.     // Only the host has the permission to delete the session.    if (!session.IsHost)    {        Debug.LogWarning("Only the host can delete the session.");        return;    }    try    {        // 2. Obtain the host session interface and execute the deletion.        await session.AsHost().DeleteAsync();                Debug.Log("Session deleted successfully.");    }    catch (SessionException e)    {        // The Multiplayer Services SDK uses SessionException for API errors.        Debug.Log(e);    }}

Documentation

Development

User Acquisition

Monetization

Industry