docs.unity3d.com
  • Manual
  • Scripting API
  • Changelog
  • License

    • Unity.DigitalTwins.Live.Sdk.Abstractions
      • AuthorizedMessagingClient
      • LiveMessagingClient
    • Unity.DigitalTwins.Live.Sdk.Implementations
      • MessagingClientWrapper
      • ServiceHttpClientWrapper
      • SignalBus
    • Unity.DigitalTwins.Live.Sdk.Interfaces
      • IMessagingClientWrapper
      • IServiceHttpClientWrapper
      • ISignalBus
    • Unity.DigitalTwins.Live.Sdk.Mappers
      • DeviceMapper
      • DeviceTelemetriesMapper
      • NotificationMapper
      • TelemetryAggregateMapper
      • TelemetryMapper
    • Unity.DigitalTwins.Live.Sdk.Mappers.Configurations.DeviceSummaries
      • DeviceSummaryMapper
    • Unity.DigitalTwins.Live.Sdk.Mappers.Configurations.Plots
      • AxisPropertiesMapper
      • PlotConfigurationMapper
      • SeriesPropertiesMapper
    • Unity.DigitalTwins.Live.Sdk.Mappers.Configurations.Plots.TimeSeries
      • TimeSeriesPlotConfigurationMapper
      • TimeSeriesPropertiesMapper
    • Unity.DigitalTwins.Live.Sdk.Mappers.DataAssociations
      • CustomPropertiesListMapper
      • CustomPropertiesMapper
      • DeviceListMapper
      • RuleInterpreterListMapper
      • RuleInterpreterMapper
      • RuleListMapper
      • RuleMapper
    • Unity.DigitalTwins.Live.Sdk.Models
      • Device
      • DeviceTelemetries
      • FacilityInfo
      • LiveDevice
      • Notification
      • PulsingMaterialData
      • PulsingState
      • Telemetry
      • TelemetryAggregate
      • TelemetryHistory
    • Unity.DigitalTwins.Live.Sdk.Models.Configurations.DeviceSummaries
      • DeviceSummary
    • Unity.DigitalTwins.Live.Sdk.Models.Configurations.Plots
      • AxisProperties
      • PlotConfiguration
      • SeriesProperties
    • Unity.DigitalTwins.Live.Sdk.Models.Configurations.Plots.TimeSeries
      • TimeSeriesPlotConfiguration
      • TimeSeriesProperties
    • Unity.DigitalTwins.Live.Sdk.Models.DataAssociations
      • CustomProperties
      • Rule
      • RuleInterpreter
    • Unity.DigitalTwins.Live.Sdk.Samples.Services
      • DebugSignalBus
    • Unity.DigitalTwins.Live.Sdk.Samples.Services.Controllers
      • ConfigurationController
      • DeviceController
      • FacilityController
      • LoginController
      • NotificationController
      • ServicesController
      • TelemetryHistoryController
    • Unity.DigitalTwins.Live.Sdk.Samples.Services.Editor
      • ConfigurationControllerEditor
      • DeviceControllerEditor
      • FacilityControllerEditor
      • NotificationControllerEditor
      • TelemetryHistoryControllerEditor
    • Unity.DigitalTwins.Live.Sdk.Samples.Services.Models
      • ConfigurationServiceResult
      • DeviceServiceResult
      • DeviceSummaryResult
      • FacilityServiceResult
      • LiveDeviceResultView
      • NotificationServiceResult
      • TelemetryHistoryServiceResult
    • Unity.DigitalTwins.Live.Sdk.Services.Implementations
      • ConfigurationService
      • DataAssociationsService
      • DeviceService
      • FacilityService
      • NotificationService
      • TelemetryHistoryService
    • Unity.DigitalTwins.Live.Sdk.Services.Interfaces
      • IConfigurationService
      • IDataAssociationsService
      • IDeviceService
      • IFacilityService
      • INotificationService
      • ITelemetryHistoryService
    • Unity.DigitalTwins.Live.Sdk.Settings
      • CameraSettings
      • EnvironmentSettings
      • NavigationSettings
    • Unity.DigitalTwins.Live.Sdk.Signals
      • CameraInteractionModeUpdatedSignal
      • CameraInteractionModeUpdatedSignal.CameraInteractionMode
      • CameraZoomedSignal
      • DataAssociatedSignal
      • DeviceTelemetriesReceivedSignal
      • HoverChangedSignal
      • LiveDevicesReceivedSignal
      • LiveDeviceUpdatedSignal
      • LoginStateChangedSignal
      • ModifySelectionRequestSignal
      • NavigationTargetUpdatedSignal
      • NotificationReceivedSignal
      • SelectionChangedSignal
      • SettingChangedSignal
      • TelemetryAggregateReceivedSignal
    • Unity.DigitalTwins.Live.Sdk.Tests.Editor
      • PlaceholderUnitTests
    • Unity.DigitalTwins.Live.Sdk.Tests.Editor.Utilities
      • ServicesTestFactory
      • TestFactory
    • Unity.DigitalTwins.Live.Sdk.Utilities
      • ClientUtility
      • Constants
      • DeviceTopic
      • Optional
      • Optional<T>

    Class MessagingClientWrapper

    Inheritance
    Object
    MessagingClientWrapper
    Implements
    IMessagingClientWrapper
    IAsyncDisposable
    Namespace: Unity.DigitalTwins.Live.Sdk.Implementations
    Assembly: solution.dll
    Syntax
    public sealed class MessagingClientWrapper : IMessagingClientWrapper, IAsyncDisposable, IDisposable

    Constructors

    MessagingClientWrapper(IServiceMessagingClient, EnvironmentSettings)

    Declaration
    public MessagingClientWrapper(IServiceMessagingClient messagingClient, EnvironmentSettings environmentSettings)
    Parameters
    Type Name Description
    IServiceMessagingClient messagingClient
    EnvironmentSettings environmentSettings

    Properties

    State

    Declaration
    public ConnectionState State { get; }
    Property Value
    Type Description
    ConnectionState

    Methods

    ConnectAsync(String)

    Opens a connection to a server and prepare validation parameters for other class methods.

    Declaration
    public async Task ConnectAsync(string cloudServicesAccessToken)
    Parameters
    Type Name Description
    String cloudServicesAccessToken

    Validates access to cloud services.

    Returns
    Type Description
    Task

    DisconnectAsync()

    Disconnects from the server.

    Declaration
    public async Task DisconnectAsync()
    Returns
    Type Description
    Task

    Dispose()

    Declaration
    public void Dispose()

    DisposeAsync()

    Declaration
    public async ValueTask DisposeAsync()
    Returns
    Type Description
    ValueTask

    SendAsync(IEnumerable<Message>)

    Awaitable method to send a message to a server

    Declaration
    public Task SendAsync(IEnumerable<Message> messages)
    Parameters
    Type Name Description
    IEnumerable<Message> messages

    Messages to be sent.

    Returns
    Type Description
    Task

    Events

    OnDeviceTelemetriesAvailable

    Returns updated device telemetries.

    Declaration
    public event Action<DeviceTelemetriesResource> OnDeviceTelemetriesAvailable
    Event Type
    Type Description
    Action<DeviceTelemetriesResource>

    OnNotificationReceived

    Returns received notifications.

    Declaration
    public event Action<NotificationResource> OnNotificationReceived
    Event Type
    Type Description
    Action<NotificationResource>

    OnTelemetryAggregateAvailable

    Returns updated telemetry aggregates.

    Declaration
    public event Action<TelemetryAggregateResource> OnTelemetryAggregateAvailable
    Event Type
    Type Description
    Action<TelemetryAggregateResource>

    Implements

    IMessagingClientWrapper
    IAsyncDisposable
    Back to top Generated by DocFX
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023