Class UGCProjectApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

UGCProjectApi

Implements

IUGCProjectApi

IApiAccessor

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Services.Apis.UGC

Assembly: solution.dll

Syntax

public class UGCProjectApi : IUGCProjectApi, IApiAccessor

Constructors

UGCProjectApi(IApiClient)

Initializes a new instance of the UGCProjectApi class using a Configuration object and client instance.

Declaration

public UGCProjectApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

UGCProjectApi(IApiClient, IApiConfiguration)

Initializes a new instance of the UGCProjectApi class using a Configuration object and client instance.

Declaration

public UGCProjectApi(IApiClient apiClient, IApiConfiguration apiConfiguration)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.
IApiConfiguration	apiConfiguration	The configuration object.

Properties

Client

The client for accessing this underlying API asynchronously.

Declaration

public IApiClient Client { get; }

Property Value

Type	Description
IApiClient

Configuration

Gets the configuration object

Declaration

public IApiConfiguration Configuration { get; }

Property Value

Type	Description
IApiConfiguration	An instance of the Configuration

Methods

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetProject(string, CancellationToken)

Get details about a project

Declaration

public ApiOperation<ProjectDTO> GetProject(string projectId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Project identifier
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ProjectDTO>	The operation

SearchProjects(int?, int?, List<string>, string, List<string>, bool?, CancellationToken)

Search all projects

Declaration

public ApiOperation<ProjectDTOPagedResult> SearchProjects(int? offset = null, int? limit = null, List<string> sortBys = null, string search = null, List<string> filters = null, bool? includeTotal = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	offset	The amount of results to skip (optional)
int?	limit	The amount of results to take (optional)
List<string>	sortBys	The field to use to sort by in ascending order, prefix - for descending (optional)
string	search	Only return results with this search term in their name (optional)
List<string>	filters	You can filter on any field in the DTO<br /> Syntax for filters is: {field},{operator},{value}<br /> The operators are: eq (equal to), neq (not equal to), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal)<br /> The field can be nested up to two levels. Ex: "field.nestedField.nestedNestedField"<br /> filters="deletedAt,eq,null" will only return entities that have not been deleted<br /> (optional)
bool?	includeTotal	Should the result include the total count of objects available to page (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ProjectDTOPagedResult>	The operation

Implements

IUGCProjectApi

IApiAccessor