Cephable.Core 1.0.11

Cephable Core

The Cephable Core provides the foundation for building applications with advanced voice controls, device profiles, and user authentication. This contains the core models and services that can be extended for various platforms like WPF and WinUI3.

Overview

The Cephable Core SDK is designed to handle the core functionalities required to build dynamic, voice-controlled applications. It includes:

• Cephable Service Integration: A central service that integrates various features like voice controls, device profiles, and user authentication..
• API Service: Handles communication with Cephable's backend services for user management, device control, and more.
• Device Profile Management: Services for handling user device profiles, including loading, updating, and switching profiles.
• HTTP Data Provider: A robust, generic service for making HTTP requests.

Extensions

This SDK is extended by other SDKs:

• Cephable WPF SDK: Provides WPF-specific implementations of the services in this SDK.
• Cephable WinUI3 SDK: Provides WinUI3-specific implementations.

Services

1. CephableService

Purpose: A central service that integrates various features like voice controls, device profiles, and user authentication.

Key Methods:

• InitializeAsync(CephableConfiguration config): Initializes the Cephable service with the provided configuration.
• StartVoiceControls(VoiceControlsConfiguration config): Starts voice controls with the specified configuration.

Example:

var cephableService = new CephableService(voiceService, apiService, secureStorageProvider, authService, deviceProfileService, keyboardMouseService, desktopService);
await cephableService.InitializeAsync(new CephableConfiguration
{
    DeviceTypeId = "deviceTypeId",
    DeviceName = "My Device",
    AuthConfiguration = new AuthConfiguration
    {
        ClientId = "clientId",
        RedirectUri = "redirectUri"
    }
});

2. CephableApiService

Purpose: Handles communication with Cephable's backend services for user management, device control, and more.

Key Methods:

• GetUserDevices(): Retrieves a list of user devices.
• CreateProfile(UpdateUserDeviceProfileRequest configuration): Creates a new device profile.
• GetVoiceModelReferenceForLocale(string locale, string fileFormat): Retrieves a voice model reference for a specific locale.

Example:

var apiService = new CephableApiService(new CephableApiConfiguration { BaseUrl = "https://api.cephable.com" }, new CephableHttpClient());
var userDevices = await apiService.GetUserDevices();
var profileResult = await apiService.CreateProfile(new UpdateUserDeviceProfileRequest
{
    ProfileName = "New Profile",
    Configuration = new DeviceProfileConfiguration { /* profile configuration */ }
});

3. DeviceProfileService

Purpose: Manages user device profiles, allowing you to load, update, and switch between profiles dynamically.

Key Properties:

• Profiles: Holds the list of user device profiles.
• CurrentProfile: The currently active profile.

Key Methods:

• LoadProfiles(): Loads profiles from secure storage or the API.
• UpdateLocalProfiles(List<UserDeviceProfileModel> profiles): Updates and saves local profiles.

Example:

var deviceProfileService = new DeviceProfileService(secureStorageProvider, apiService, authService);
var profiles = await deviceProfileService.LoadProfiles();
deviceProfileService.CurrentProfile = profiles.FirstOrDefault();

Installation

To install the Cephable Core SDK, use the following NuGet command:

Install-Package Cephable.Core

Getting Started

1. Install the Cephable Core SDK via NuGet.
2. Create and configure the necessary services.
3. Integrate voice controls, device profiles, and user authentication into your application.

License

The Cephable WPF SDK is only available to licensed users. Ensure that your application complies with Cephable�s licensing terms. For more details on obtaining a license, please contact Cephable Sales.

Support and Contact

For any inquiries, please contact Cephable or your account representatitve.