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 DeviceService

    Connects to a server to receive information on all .

    Inheritance
    Object
    DeviceService
    Implements
    IDeviceService
    Namespace: Unity.DigitalTwins.Live.Sdk.Services.Implementations
    Assembly: solution.dll
    Syntax
    public class DeviceService : IDeviceService, IDisposable

    Constructors

    DeviceService(EnvironmentSettings, IServiceHttpClientWrapper, ISignalBus)

    Creates an instance of DeviceService.

    Declaration
    public DeviceService(EnvironmentSettings environmentSettings, IServiceHttpClientWrapper serviceHttpClientWrapper, ISignalBus signalBus)
    Parameters
    Type Name Description
    EnvironmentSettings environmentSettings

    The EnvironmentSettings instance.

    IServiceHttpClientWrapper serviceHttpClientWrapper

    The instance of IServiceHttpClientWrapper.

    ISignalBus signalBus

    The instance of ISignalBus.

    Methods

    Dispose()

    Clean-up code that releases resources.

    Declaration
    public void Dispose()

    FireLiveDeviceUpdated(LiveDevice)

    Fires an event when a has been updated.

    Declaration
    public void FireLiveDeviceUpdated(LiveDevice liveDevice)
    Parameters
    Type Name Description
    LiveDevice liveDevice

    The that has been updated.

    GetCachedDevices()

    Retrieves all cached .

    Declaration
    public IEnumerable<LiveDevice> GetCachedDevices()
    Returns
    Type Description
    IEnumerable<LiveDevice>

    Returns a list of all .

    GetDevicesAsync()

    Gets all devices .

    Declaration
    public async Task<IEnumerable<LiveDevice>> GetDevicesAsync()
    Returns
    Type Description
    Task<IEnumerable<LiveDevice>>

    GetSelectedLiveDevices()

    Retrieves all selected .

    Declaration
    public IEnumerable<LiveDevice> GetSelectedLiveDevices()
    Returns
    Type Description
    IEnumerable<LiveDevice>

    Returns a list of all selected .

    TryGetLiveDevice(String, out LiveDevice)

    Retrieves a .

    Declaration
    public bool TryGetLiveDevice(string deviceId, out LiveDevice liveDevice)
    Parameters
    Type Name Description
    String deviceId

    The ID used to retrieve the .

    LiveDevice liveDevice

    The returned .

    Returns
    Type Description
    Boolean

    Returns true if the operation is successful.

    Implements

    IDeviceService
    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