Interface IFriendsPresenceApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.Friends

Assembly: Unity.Services.Apis.dll

Syntax

public interface IFriendsPresenceApi : IApiAccessor

Methods

GetPresence(string, CancellationToken)

Get presence for a user.

Declaration

ApiOperation<UserPresence> GetPresence(string userId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	userId	The userID.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<UserPresence>	The operation

SetPresence(PresenceRequest, CancellationToken)

Set presence for a user.

Declaration

ApiOperation<UserPresence> SetPresence(PresenceRequest presenceRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PresenceRequest	presenceRequest	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<UserPresence>	The operation