Class AppUtils

AppUtils is a utility class that provides helper methods for platform detection, dependency resolution, timer management, and accessing application-level services.

Index

Constructors

constructor

new AppUtils(): AppUtils.AppUtils
Returns AppUtils.AppUtils

Properties

`Private`__hs_global

__hs_global: any

Global platform-specific object, decorated with @platformGlobal.

`Private` `Static`_instance

_instance: undefined | AppUtils.AppUtils

Singleton instance of AppUtils.

Accessors

`Static`instance

get instance(): AppUtils.AppUtils
Returns AppUtils.AppUtils
set instance(instance: AppUtils.AppUtils): void
Parameters
- instance: AppUtils.AppUtils
Returns void

Methods

`Static`clearInterval

clearInterval(timerId: number): void
Clears a timer with the specified timer ID.
Parameters
- timerId: number
  The ID of the timer to clear.
Returns void

`Static`getApp

getApp(): BaseApp.BaseApp
Returns BaseApp.BaseApp
Deprecated
Retained for backwards compatibility. New framework code should use HosannaAppUtils for UI-dependent helpers.

`Static`getAsyncCommand

getAsyncCommand(): AsyncCommand
Returns AsyncCommand
Deprecated
Retained for backwards compatibility. New framework code should use HosannaAppUtils for UI-dependent helpers.

`Static`getBuildConfig

getBuildConfig<T>(key: string, defaultValue?: unknown): T
Type Parameters
- T
Parameters
- key: string
- OptionaldefaultValue: unknown
Returns T

`Static`getDebugFlag

getDebugFlag<T>(key: string): T
Type Parameters
- T
Parameters
- key: string
Returns T
Deprecated
Use getBuildConfig.

`Static`getPlatform

getPlatform(): PlatformType
Detects the current running platform.

Returns PlatformType
The type of the platform.

`Static`getTimerService

getTimerService(): TimerService.TimerService
Retrieves the TimerService instance from the global container.

Returns TimerService.TimerService
The TimerService instance.

`Static`register

register(key: string, service: any): void
Registers a service in the global container.
Parameters
- key: string
  The key to associate with the service.
- service: any
  The service instance to register.
Returns void

`Static`resolve

resolve<T>(key: string, isRequired?: boolean): T
Resolves a dependency from the global container or IoC container. Throws an error if the dependency is required but not found.
Type Parameters
- T
Parameters
- key: string
  The key of the dependency to resolve.
- isRequired: boolean = true
  Whether the dependency is required (default: true).
Returns T
The resolved dependency instance.

Throws
Error if the dependency is required but not found.

`Static`sayAudioGuideItem

sayAudioGuideItem(item: undefined | IAudioGuideItem): void
Parameters
- item: undefined | IAudioGuideItem
Returns void
Deprecated
Use HosannaAppUtils.sayAudioGuideItem.

`Static`sayText

sayText(
    text: string,
    priority?: number,
    _origin?: IHosannaView<ViewState>,
    flushPrevious?: boolean,
): void
Parameters
- text: string
- Optionalpriority: number
- Optional_origin: IHosannaView<ViewState>
- OptionalflushPrevious: boolean
Returns void
Deprecated
Use HosannaAppUtils.sayText.

`Static`sendSystemMessage

sendSystemMessage(level: SystemMessageLevel, text: string): void
Parameters
- level: SystemMessageLevel
- text: string
Returns void
Deprecated
Use HosannaAppUtils.sendSystemMessage.

`Static`setTimer

setTimer(callback: Function, interval: number, repeat?: boolean): number
Sets a timer with the specified callback, interval, and repeat flag.
Parameters
- callback: Function
  The function to execute when the timer elapses.
- interval: number
  The interval in milliseconds.
- repeat: boolean = false
  Whether the timer should repeat (default: false).
Returns number
The timer ID.

Class AppUtils

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AppUtils.AppUtils

Properties

Private__hs_global

Private Static_instance

Accessors

Staticinstance

Returns AppUtils.AppUtils

Parameters

Returns void

Methods

StaticclearInterval

Parameters

Returns void

StaticgetApp

Returns BaseApp.BaseApp

Deprecated

StaticgetAsyncCommand

Returns AsyncCommand

Deprecated

StaticgetBuildConfig

Type Parameters

Parameters

Returns T

StaticgetDebugFlag

Type Parameters

Parameters

Returns T

Deprecated

StaticgetPlatform

Returns PlatformType

StaticgetTimerService

Returns TimerService.TimerService

Staticregister

Parameters

Returns void

Staticresolve

Type Parameters

Parameters

Returns T

Throws

StaticsayAudioGuideItem

Parameters

Returns void

Deprecated

StaticsayText

Parameters

Returns void

Deprecated

StaticsendSystemMessage

Parameters

Returns void

Deprecated

StaticsetTimer

Parameters

Returns number

Settings

On This Page

`Private`__hs_global

`Private` `Static`_instance

`Static`instance

`Static`clearInterval

`Static`getApp

`Static`getAsyncCommand

`Static`getBuildConfig

`Static`getDebugFlag

`Static`getPlatform

`Static`getTimerService

`Static`register

`Static`resolve

`Static`sayAudioGuideItem

`Static`sayText

`Static`sendSystemMessage

`Static`setTimer