Interface IRoomJoiner
Provides functionalities to join or leave a room.
Namespace: Unity.Cloud.Presence
Syntax
public interface IRoomJoiner : ISessionProviderProperties
ConnectionStatus
Gets the status of the connection to the join service.
Declaration
ConnectionStatus ConnectionStatus { get; }Property Value
| Type | Description |
|---|---|
| ConnectionStatus |
Methods
JoinAsync(BaseRoom, IRetryPolicy, CancellationToken)
Joins a room.
Declaration
Task JoinAsync(BaseRoom room, IRetryPolicy retryPolicy, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| BaseRoom | room | The room to join |
| IRetryPolicy | retryPolicy | The retry policy to execute the operation |
| CancellationToken | cancellationToken | Cancellation token that will try to cancel the operation |
Returns
| Type | Description |
|---|---|
| Task | Task representing the request to join |
LeaveAsync()
Leaves the joined room.
Declaration
Task LeaveAsync()Returns
| Type | Description |
|---|---|
| Task | Task representing the request to leave |
Events
ConnectionStatusChanged
Generates an event when the status of the connection changes.
Declaration
event Action<ConnectionStatus> ConnectionStatusChangedEvent Type
| Type | Description |
|---|---|
| Action<ConnectionStatus> |