Namespace Unity.Cloud.Common
Classes
AesStringObfuscator
An IStringObfuscator implementation that uses AesCryptoServiceProvider encryption and decryption methods to obfuscate string values.
ApiSourceVersion
A class containing version information about the source API.
ApiSourceVersionAttribute
An attribute to store apiSourceVersion for a given Assembly.
AppInfo
A class containing identifying information about an App.
AppInfoProvider
A class which provides access to App information as registered on the Digital Twin Dashboard.
AsyncUrlRedirectAwaiter
AuthenticationFailedException
This exception is thrown when a user authentication failed. Mostly occurs when the authentication token sent to the server is invalid or expired.
ConnectionException
This exception is thrown if the connection to the server fails.
CoreTimeAwaiter
CoreUrlProcessor
DeviceCodeExpiredException
This exception is thrown when a device code is expired.
DotNetHttpClient
An implementation of IHttpClient for .Net specific applications
ExponentialBackoffRetryPolicy
An implementation of IRetryPolicy that employs an "Exponential Backoff With Jitter" strategy.
FileKeyValueStore
An IKeyValueStore implementation that uses text files for storage.
ForbiddenException
This exception is thrown when a user request a resource but does not have the right to access it.
HttpClientExtensions
Helper methods for IHttpClient.
HttpClientJsonExtensions
Helper methods for IHttpClient
HttpResponseMessageExtensions
Helper methods for HttpResponseMessage.
IKeyValueStoreExtensions
InvalidArgumentException
This exception is thrown when the request sent is missing some values or arguments.
IServiceMessagingClientExtensions
JsonSerialization
A class to serialize and deserialize objects to JSON.
LaunchArgumentsParser
This class handles launch arguments parsing of the current running process.
LicenseUnavailableException
This exception is thrown by
LogEvent
Object that holds the information associated to a single log
LoggerExtension
Helpers function for logging
LoggerProvider
Main UCLogger class that allow retrieving/creating a UCLogger object
LogOutputs
Manages all log outputs
MaxSeatReachedException
This exception is thrown when some floating licenses exist, but are all taken.
Message
Object used to contain messaging information
MessageCollection
Object used to store multiple Message objects and corresponding checkpoints
NoEntitlementAvailableException
This exception is thrown when the requested entitlement is not available.
NoRetryPolicy
An implementation of IRetryPolicy that tries only once.
NoSeatEntitlementException
This exception is thrown when no entitlement exist for the requested floating license.
NotFoundException
Permission
This class contains information about a single permission verb for a resource.
QueryArgumentsParser
Helper methods to parse query arguments from a Uri.
RetryExecutionFailedException
This exception is thrown by ExecuteAsync<T>(IRetryPolicy.RetriedOperation<T>, IRetryPolicy.ShouldRetryChecker<T>, CancellationToken, IProgress<RetryQueuedProgress>) when a critical exception (passed as innerException) occurs during execution of the retry policy.
RetryPolicyExtensions
ServerException
This exception is thrown when the server encountered an unexpected error.
ServiceError
Represents an error returned by a service.
ServiceErrorAttribute
ServiceErrorMessage
Contains default error messages of ServiceException.
ServiceException
ServiceExceptionFactory
ServiceHeaderUtils
Helper methods for managing HTTP headers.
ServiceHostConfiguration
A class representing a configuration for the service environment for the application.
ServiceHostConfigurationFactory
A factory class used to create a ServiceHostConfiguration.
ServiceHostResolver
Resolves the service environment and domain provider for the application.
ServiceHostResolverFactory
A factory class used to create a IServiceHostResolver.
ServiceHttpClient
An implementation of an HTTP client which abstracts the Task of sending HttpRequestMessage.
ServiceHttpClientExtensions
Helper methods for IServiceHttpClient.
ServiceMessagingClient
Interface for a messaging client used to connect to a service and send/receive messages
UCLogger
Class used to do the actual logging from dev code.
UnauthorizedException
This exception is thrown when an unauthenticated user tries to access a resource that requires authentication.
UnknownApplicationException
This exception is thrown when the application ID header is not valid.
UriSchemeRedirection
A static class that holds the uri scheme prefix used to secure app binding on a device.
UrlRedirectUtils
WebSocketHeaders
Structs
HttpProgress
Contains status information on the progress of an IHttpClient operation.
InstanceId
This struct holds information about instance identifier.
OrganizationId
This struct holds information about organization identifier.
RetryQueuedProgress
Contains information about a RetryQueue event, when using ExecuteAsync<T>(IRetryPolicy.RetriedOperation<T>, IRetryPolicy.ShouldRetryChecker<T>, CancellationToken, IProgress<RetryQueuedProgress>) or its additional extensions.
SceneId
This struct holds information about scene identifier.
SceneVersionId
This struct holds information about scene version identifier.
ServiceHost
Contains the values for ServiceEnvironment and ServiceDomainProvider.
ServiceHttpClientOptions
A class to configure options for a IServiceHttpClient
ServiceMessagingClientOptions
A class to configure options for a IServiceMessagingClient
UrlRedirectResult
This struct contains information about url redirection operation.
WorkspaceId
This struct holds information about workspace identifier.
Interfaces
IAccessTokenProvider
This interface abstracts the Task of returning the string value of the user access token to get authenticated on cloud endpoints.
IAppDisplayNameProvider
An interface that represents a provider for an app display name.
IAppIdProvider
An interface that represents a provider of an app ID.
IAppInfoProvider
Interface that represent a provider for app information.
IAppNameProvider
An interface that represents a provider for an app name.
IClipboard
An interface for clipboard features.
IHttpClient
Interface that represent a client for making http requests.
IKeyValueStore
An interface which abstracts methods related to reading and writing string content to a persistent file storage.
ILogOutput
Interface to implement to be able to receive log and act upon them (e.g. write to file)
IRetryPolicy
Interface which abstracts Retry Policies.
IScene
This interface holds information about a scene.
IServiceHostResolver
Resolves the service environment and domain provider for the application.
IServiceHttpClient
This interface abstracts the Task of sending HttpRequestMessage.
IServiceMessagingClient
Interface for a messaging client used to connect to a service and send/receive messages
IStringObfuscator
An interface providing encryption and decryption methods to obfuscate string values.
ITimeAwaiter
IUrlProcessor
An interface to handle the execution of an URL.
IUrlRedirectAwaiter
Configures the refresh rate and timeout delay for awaiting a UrlRedirectResult.
IUrlRedirectionInterceptor
This interface abstracts url redirection interception and validation of awaited query arguments.
IWebSocketClient
An interface for using a Messaging client and listen to events.
Enums
ConnectionState
Enum to track different client states
LogLevel
Different levels of logging. Higher level have higher numerical value and thus are more important.
ServiceDomainProvider
Enum of all supported service domain providers.
ServiceEnvironment
Enum of all supported service environments.
ServiceError.Code
Enum of all known error codes that can be thrown by a service.
ServiceProtocol
Enum of all supported protocols to connect to a Server.
UrlRedirectStatus
Lists the possible statuses for a UrlRedirect operation.
Delegates
IRetryPolicy.RetriedOperation
Delegate to define the operation that might be retried.
IRetryPolicy.RetriedOperation<T>
Delegate to define the operation that might be retried.
IRetryPolicy.ShouldRetryChecker<T>
Delegate to define whether an operation should be retried. RetryExecutionFailedException is the only valid exception that can be thrown.
IRetryPolicy.ShouldRetryExceptionChecker
Use this delegate to define which exceptions trigger a retry. It should NOT throw any exception.
IRetryPolicy.ShouldRetryResultChecker<T>
Use this delegate to define which results trigger a retry. It should NOT throw any exception.