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 FacilityService

    Connects to a server to retrieve facility information.

    Inheritance
    Object
    FacilityService
    Implements
    IFacilityService
    Namespace: Unity.DigitalTwins.Live.Sdk.Services.Implementations
    Assembly: solution.dll
    Syntax
    public class FacilityService : IFacilityService

    Constructors

    FacilityService(IMessagingClientWrapper, EnvironmentSettings, ISignalBus)

    Creates an instance of IFacilityService.

    Declaration
    public FacilityService(IMessagingClientWrapper messagingClientWrapper, EnvironmentSettings environmentSettings, ISignalBus signalBus)
    Parameters
    Type Name Description
    IMessagingClientWrapper messagingClientWrapper

    The IMessagingClientWrapper implementation.

    EnvironmentSettings environmentSettings

    The EnvironmentSettings instance.

    ISignalBus signalBus

    The signal bus that fires facility related events.

    Methods

    ConnectAsync(IScene, UserInfo, String)

    Connects to the server asynchronously.

    Declaration
    public async Task ConnectAsync(IScene scene, UserInfo user, string accessToken)
    Parameters
    Type Name Description
    IScene scene

    The IScene implementation.

    UserInfo user

    The instance of UserInfo.

    String accessToken

    The access token string.

    Returns
    Type Description
    Task

    DisconnectAsync()

    Disconnects from the facility service.

    Declaration
    public async Task DisconnectAsync()
    Returns
    Type Description
    Task

    GetFacilityInfo()

    Retrieves FacilityInfo, which includes facility ID, workspace ID, hosted server ID, and login status.

    Declaration
    public FacilityInfo GetFacilityInfo()
    Returns
    Type Description
    FacilityInfo

    Implements

    IFacilityService
    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