1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-17 21:32:55 +08:00
osu-lazer/osu.Game/Online/Metadata/IMetadataServer.cs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

58 lines
2.4 KiB
C#
Raw Normal View History

2022-07-04 16:18:33 +08:00
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.
using System.Threading.Tasks;
using osu.Game.Users;
2022-07-04 16:18:33 +08:00
namespace osu.Game.Online.Metadata
{
/// <summary>
/// Metadata server is responsible for keeping the osu! client up-to-date with various real-time happenings, such as:
/// <list type="bullet">
/// <item>beatmap updates via BSS,</item>
/// <item>online user activity/status updates,</item>
/// <item>other real-time happenings, such as current "daily challenge" status.</item>
/// </list>
2022-07-04 16:18:33 +08:00
/// </summary>
public interface IMetadataServer
{
/// <summary>
/// Get any changes since a specific point in the queue.
/// Should be used to allow the client to catch up with any changes after being closed or disconnected.
/// </summary>
/// <param name="queueId">The last processed queue ID.</param>
/// <returns></returns>
Task<BeatmapUpdates> GetChangesSince(int queueId);
/// <summary>
/// Signals to the server that the current user's <see cref="UserActivity"/> has changed.
/// </summary>
Task UpdateActivity(UserActivity? activity);
/// <summary>
/// Signals to the server that the current user's <see cref="UserStatus"/> has changed.
/// </summary>
Task UpdateStatus(UserStatus? status);
/// <summary>
/// Signals to the server that the current user would like to begin receiving updates on other users' online presence.
/// </summary>
Task BeginWatchingUserPresence();
/// <summary>
/// Signals to the server that the current user would like to stop receiving updates on other users' online presence.
/// </summary>
Task EndWatchingUserPresence();
/// <summary>
/// Signals to the server that the current user would like to begin receiving updates about the state of the multiplayer room with the given <paramref name="id"/>.
/// </summary>
Task<MultiplayerPlaylistItemStats[]> BeginWatchingMultiplayerRoom(long id);
/// <summary>
/// Signals to the server that the current user would like to stop receiving updates about the state of the multiplayer room with the given <paramref name="id"/>.
/// </summary>
Task EndWatchingMultiplayerRoom(long id);
2022-07-04 16:18:33 +08:00
}
}