ICloudApiClient Interface Reference

Handles basic REST-type requests to the Cloud API by creating UnityWebRequests with the relevant data, executing these requests with UnityHttpClient and deserializing the response data. More...

Inheritance diagram for ICloudApiClient:

Public Member Functions
Task< CloudApiResponse< T > >	Get< T > (string endpoint, CancellationToken cancellationToken)
	Get an item at a given API endpoint.
Task< CloudApiResponse< T > >	AnonymousGet< T > (string endpoint, CancellationToken cancellationToken)
	Get an item at a given API endpoint without authorization.
Task< CloudApiResponse< CloudApiPage< T > > >	GetPage< T > (string endpoint, int limit, string continueToken, CancellationToken cancellationToken)
	Get a page of items at a given API endpoint.
Task< CloudApiResponse< TResponse > >	Post< TRequest, TResponse > (string endpoint, TRequest payload, CancellationToken cancellationToken)
	Create an item or trigger an action at a given API endpoint.
Task< CloudApiResponse< T > >	Put< T > (string endpoint, T payload, CancellationToken cancellationToken)
	Update an item at a given API endpoint.
Task< CloudApiResponse< T > >	Delete< T > (string endpoint, CancellationToken cancellationToken)
	Removes an item at a given API endpoint.
Task< CloudApiResponse< T > >	AnonymousUploadToAzureBlobStorage< T > (string signedUrl, byte[] data, CancellationToken cancellationToken)
	Uploads binary data to a given Azure Blob Storage signed URL.

Properties
ICloudAuthentication	Auth [get]
	Used for authenticating requests.

Detailed Description

Handles basic REST-type requests to the Cloud API by creating UnityWebRequests with the relevant data, executing these requests with UnityHttpClient and deserializing the response data.

Member Function Documentation

AnonymousGet< T >()

Task< CloudApiResponse< T > > AnonymousGet< T >	(	string	endpoint,
		CancellationToken	cancellationToken )

Get an item at a given API endpoint without authorization.

Template Parameters

T	The expected Cloud response model.

Implemented in CloudApiClient.

AnonymousUploadToAzureBlobStorage< T >()

Task< CloudApiResponse< T > > AnonymousUploadToAzureBlobStorage< T >	(	string	signedUrl,
		byte[]	data,
		CancellationToken	cancellationToken )

Uploads binary data to a given Azure Blob Storage signed URL.

Implemented in CloudApiClient.

Delete< T >()

Task< CloudApiResponse< T > > Delete< T >	(	string	endpoint,
		CancellationToken	cancellationToken )

Removes an item at a given API endpoint.

Template Parameters

T	The expected Cloud response model.

Implemented in CloudApiClient.

Get< T >()

Task< CloudApiResponse< T > > Get< T >	(	string	endpoint,
		CancellationToken	cancellationToken )

Get an item at a given API endpoint.

Template Parameters

T	The expected Cloud response model.

Implemented in CloudApiClient.

GetPage< T >()

Task< CloudApiResponse< CloudApiPage< T > > > GetPage< T >	(	string	endpoint,
		int	limit,
		string	continueToken,
		CancellationToken	cancellationToken )

Get a page of items at a given API endpoint.

Template Parameters

T	The expected Cloud response model.

Implemented in CloudApiClient.

Post< TRequest, TResponse >()

Task< CloudApiResponse< TResponse > > Post< TRequest, TResponse >	(	string	endpoint,
		TRequest	payload,
		CancellationToken	cancellationToken )

Create an item or trigger an action at a given API endpoint.

Template Parameters

TRequest	The Cloud request model.
TResponse	The expected Cloud response model.

Implemented in CloudApiClient.

Put< T >()

Task< CloudApiResponse< T > > Put< T >	(	string	endpoint,
		T	payload,
		CancellationToken	cancellationToken )

Update an item at a given API endpoint.

Template Parameters

T	The expected Cloud response model.

Implemented in CloudApiClient.

Property Documentation

Auth

ICloudAuthentication Auth

get

Used for authenticating requests.

Implemented in CloudApiClient.

---

The documentation for this interface was generated from the following file:

• Runtime/Cloud/Networking/CloudApiClient.cs