Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RealityService

A service which makes requests to manage the reality viewer.

Hierarchy

  • RealityService

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _changeEvent

_changeEvent: Event<object> = new Event<{ previous?: string, current: string }>()

Private _connectEvent

_connectEvent: Event<SessionPort> = new Event<SessionPort>()

Private Optional _current

_current: string

Private contextService

contextService: ContextService

default

default: string = RealityViewer.EMPTY

The default Reality Viewer.

Private sessionService

sessionService: SessionService

Accessors

changeEvent

  • get changeEvent(): Event<object>

  • An event that is raised when the presenting reality viewer is changed.

    Returns Event<object>

connectEvent

  • An event that is raised when a reality viewer provides a session for sending and receiving application commands.

    Returns Event<SessionPort>

current

  • get current(): string | undefined

  • The URI for the currently presenting Reality Viewer.

    Returns string | undefined

Methods

install

  • install(uri: string): Promise<void>

  • Install the specified reality viewer

    Parameters

    • uri: string

    Returns Promise<void>

request

  • request(uri: string): Promise<void>

  • Request a reality viewer to be presented.

    Parameters

    • uri: string

    Returns Promise<void>

setDesired

  • setDesired(reality: object | undefined): void

  • Deprecated. Use [[RealityService#request]]

    deprecated

    Parameters

    • reality: object | undefined

    Returns void

uninstall

  • uninstall(uri: string): Promise<void>

  • Uninstall the specified reality viewer

    Parameters

    • uri: string

    Returns Promise<void>

Generated using TypeDoc