CloudApiClient Class Reference

More...

Inheritance diagram for CloudApiClient:

Public Member Functions
	CloudApiClient (ICloudAuthentication auth, IPlatformSettings platformSettings, ICloudSettings cloudSettings, IUserSettingsService userSettings, IUnityHttpClient httpClient)
async 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.
async 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.
async 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.
async 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.
async 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.
async 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.
async 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.
Properties inherited from ICloudApiClient

Detailed Description

Member Function Documentation

AnonymousGet< T >()

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

inline

Get an item at a given API endpoint without authorization.

Template Parameters

T	The expected Cloud response model.

Implements ICloudApiClient.

AnonymousUploadToAzureBlobStorage< T >()

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

inline

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

Implements ICloudApiClient.

Delete< T >()

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

inline

Removes an item at a given API endpoint.

Template Parameters

T	The expected Cloud response model.

Implements ICloudApiClient.

Get< T >()

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

inline

Get an item at a given API endpoint.

Template Parameters

T	The expected Cloud response model.

Implements ICloudApiClient.

GetPage< T >()

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

inline

Get a page of items at a given API endpoint.

Template Parameters

T	The expected Cloud response model.

Implements ICloudApiClient.

Post< TRequest, TResponse >()

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

inline

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.

Implements ICloudApiClient.

Put< T >()

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

inline

Update an item at a given API endpoint.

Template Parameters

T	The expected Cloud response model.

Implements ICloudApiClient.

Property Documentation

Auth

ICloudAuthentication Auth

get

Used for authenticating requests.

Implements ICloudApiClient.

---

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

• Runtime/Cloud/Networking/CloudApiClient.cs