Infsoft.WPE.App.Services 2.0.1

LocAware One Services library

This library provides the interfaces of all publicly available services, which can be used in an app implementation.

Services

• Analytics related:
  • IAnalyticsService Allows the application to track analytics events.
  • IPageTitleCache Provides a cache for page titles, which are used to track page views in analytics.
• Api related:
  • IRequestCache Provides an interface for the delegating handler CachingHandler to cache requests.
  • IDataReaderApi Provides easy access to the data reader Api, which allows querying configured data sources.
• AugmentedReality related:
  • IARService Provides a uniform interface for augmented reality services.
• Bluetooth Low Energy related:
  • IBluetoothLEService Provides an interface for listening for Bluetooth Low Energy devices. Also allows reading and writing GATT services.
  • IBluetoothLEWrite Provides the possibility to write data to a Bluetooth Low Energy device.
• Content related:
  • IAppMetadata Provides app metadata like the app version and build number.
  • IClearCacheService Provides a uniform interface for clearing cached data.
  • IComponentInstanceProvider Provides all registered component instances.
  • IDynamicContentService Allows setting of header content dynamically.
  • IDynamicTypeProvider Provides all loaded assembly types that are used by the IDynamicContentService.
  • INavBarChildContent Provides the possibility to set a RenderFragment as child content in the minimal navBar.
  • IObserverManager Allows observing of any resizing on a DOM element.
  • ISidebarService Allows managing the sidebar state.
• Device related:
  • IMouseManager Provides access to bubbled click events.
  • IPlatformInterop Provides interop functionality for platform-specific features.
  • ISafeAreaService Allows querying the safe area of the device.
  • IScannerService Provides access to camera-based scanning functionality.
  • IScreenBrightnessService Provides the possibility to change the screen brightness.
  • IUserAgentCache Cache for the user agent string parsing. Use IUserAgentService instead of accessing this directly.
  • IUserAgentService Service to fetch and parse the user agent string.
• Dialog related:
  • IDialogService Provides an interface to show dialogs with customizable titles, messages, buttons, and display options.
• Localization related:
  • IAppWideLocalizationDefinition Allows querying of app-wide localization definitions.
  • IStringLocalizerSetter Registers app localizations.
• Page-navigation related:
  • INavigationHistory Provides an interface to navigate between pages.
• Positioning related:
  • IMyLocationService Provides an interface to query the user's current location.
• Push notifications related:
  • INotificationActionService Allows responding to push notifications.
  • INotificationsApi Allows querying or updating the handled state of notifications.
  • IPlaygroundPush Allows the definition of push notifications for the playground (invoke them from the settings page).
  • IToastService Provides an interface to show toast notifications with configurable content, style, and behavior.
• Settings related:
  • IPlatformPreferenceService Provides a uniform interface for platform-specific settings storage.
  • ISettingsService Provides access to settings synced across platforms.
  • ITermsAndConditionsService Allows querying whether a user has accepted a specific terms and conditions entry.
  • ITimeZoneService Provides the timeZone information based on subscriptions.

Delegating handlers

Additionally, two delegating handlers are defined.

These serve to use the caching service via CachingHandler and add common headers to every request DefaultHeadersHandler.

Examples

IToastService

var config = ToastConfig.WithTitle("Data Saved")
    .WithSubTitle("Your changes were successfully stored.") // Optional: subtitle text
    .WithIconName("check-circle")                           // Optional: icon name or URL
    .WithCloseButton(true)                                  // Optional: show close button
    .CloseAfter(3000)                                       // Optional: auto-close after milliseconds
    .WithAlignment(ToastConfigAlignment.TopRight)           // Optional: position on screen
    .WithColor(ToastConfigColor.Green);                     // Optional: predefined color
    // .WithCustomColor("#00FF99")                          // Optional: use custom HEX instead
    // .NotSelfClosing()                                    // Optional: require manual close

ToastService.Show(config);

IDialogService

var buttons = new List<DialogOptionsButton>
{
    DialogOptionsButton.WithText("Submit")
        .OnClicked(() => DeleteBooking(lockerItem.Item1, lockerItem.Item2))
        .AsPrimary(),

    DialogOptionsButton.WithText("Cancel")
        .AsSecondary()
};

// Create a dialog configuration using the fluent API
var config = DialogOptions.WithTitle("Open locker")
    .WithDescription("Are you sure you want to open this locker?")  // Optional: add one or more message lines
    .WithIconName("delete")                                         // Optional: icon name or URL
    .WithButtons(buttons)                                           // Optional: custom button list
    .DisableBackgroundClose();                                      // Optional: disable closing by clicking outside

DialogService.Show(config);