### Example: Opening App Store Link

Source: https://api.essentialkit.voxelbusters.com/v3/d7/d34/class_voxel_busters_1_1_essential_kit_1_1_utilities

Demonstrates how to use the OpenAppStorePage method with platform-specific identifiers to link to an app's store page.

```C#
using UnityEngine;
using System.Collections;
using VoxelBusters.EssentialKit;

public class ExampleClass : MonoBehaviour
{
    public void OpenStorePage ()
    {
        Utilities.OpenStoreLink(PlatformValue.Android("com.example.app"), PlatformValue.IOS("ios-app-id"));
    }
}
```

--------------------------------

### Unity C# WebView Loading Example

Source: https://api.essentialkit.voxelbusters.com/v3/dd/db4/class_voxel_busters_1_1_essential_kit_1_1_web_view

Demonstrates how to initialize and use the WebView component in Unity to load a webpage. It covers setting up the WebView, loading a URL, and registering for load events.

```csharp
using UnityEngine;

using System.Collections;

using VoxelBusters.EssentialKit;

public class ExampleClass : MonoBehaviour

{

public WebView m_webView;

private void Start()

{

// set web view properties

m_webView = WebView.CreateInstance();

m_webView.SetFullScreen();

// start request

m_webView.LoadURL(new URLString("https://www.google.com"));

}

private void OnEnable()

{

// registering for event

WebView.OnShow += OnShow;

WebView.OnHide += OnHide;

WebView.OnLoadStart += OnLoadStart;

WebView.OnLoadFinish += OnLoadFinish;

}

private void OnDisable()

{

// unregistering event

WebView.OnShow -= OnShow;

WebView.OnHide -= OnHide;

WebView.OnLoadStart -= OnLoadStart;

WebView.OnLoadFinish -= OnLoadFinish;

}

private void OnShow(WebView result)

{

if (m_webView == result)

{

Debug.Log("Showing webview.");

}

}

private void OnHide(WebView result)

{

if (m_webView == result)

{

Debug.Log("Hiding webview.");

}

}

private void OnLoadStart(WebView result)

{

if (m_webView == result)

{

Debug.Log("Started loading request with url:" + m_webView.URL);

}

}

private void OnLoadFinish(WebView result, Error error)

{

if (m_webView == result)

{

if (error == null)

{

Debug.Log("Webview did finish loading request successfully.");

}

else

{

Debug.Log("Webview did fail to load request. Error: " + error.Description);

}

}

}

}
```

--------------------------------

### Example: Displaying an AlertDialog

Source: https://api.essentialkit.voxelbusters.com/v3/d6/d61/class_voxel_busters_1_1_essential_kit_1_1_alert_dialog

Demonstrates how to create, configure, and show an AlertDialog with a title, message, and a single action button using C# within a Unity MonoBehaviour.

```C#
using UnityEngine;
using System.Collections;
using VoxelBusters.EssentialKit;

public class ExampleClass : MonoBehaviour
{
    public void Start()
    {
        AlertDialog newDialog = AlertDialog.CreateInstance();
        newDialog.SetTitle(title);
        newDialog.SetMessage(message);
        newDialog.AddButton(button, OnAlertButtonClicked);
        newDialog.Show();
    }

    private void OnAlertButtonClicked()
    {
        // add your code
    }
}
```

--------------------------------

### Prompt Update Options Methods

Source: https://api.essentialkit.voxelbusters.com/v3/functions_func_s

Methods for configuring prompt update options, including allowing installation and setting force update flags.

```APIDOC
SetAllowInstallationIfDownloaded(allow)
  - Configures whether installation is allowed if the update is already downloaded.
  - Belongs to: PromptUpdateOptions.Builder

SetIsForceUpdate(force)
  - Sets a flag to indicate if the update is a forced update.
  - Belongs to: PromptUpdateOptions.Builder
```

--------------------------------

### NetworkServices Static Methods: Start, Stop, Initialize

Source: https://api.essentialkit.voxelbusters.com/v3/dd/d14/class_voxel_busters_1_1_essential_kit_1_1_network_services

Manages the lifecycle and initialization of the NetworkServices module. StartNotifier and StopNotifier control the background monitoring, while Initialize allows for custom configuration.

```APIDOC
static void StartNotifier ()
  - Starts the notifier.

static void StopNotifier ()
  - Stops the notifier.

static void Initialize (NetworkServicesUnitySettings settings)
  - Initialize the NetworkServices module with the given settings. This call is optional and only need to be called if you have custom settings to initialize this feature.
  - Parameters:
    - settings: The settings to be used for initialization. The settings configure the behavior of the NetworkServices module.
```

--------------------------------

### Network Services Methods

Source: https://api.essentialkit.voxelbusters.com/v3/functions_s

Methods for managing network services, including starting and stopping network monitoring or notifications.

```APIDOC
NetworkServices:
  StartNotifier()
    Starts the network status monitoring service.

  StopNotifier()
    Stops the network status monitoring service.
```

--------------------------------

### NetworkServices API Methods

Source: https://api.essentialkit.voxelbusters.com/v3/functions_func_s

Manages network-related operations, including starting and stopping notification services.

```APIDOC
class NetworkServices:
  StartNotifier()
    - Description: Starts the network notification service.
    - Parameters: None.
    - Returns: Void.
    - Related: StopNotifier.

  StopNotifier()
    - Description: Stops the network notification service.
    - Parameters: None.
    - Returns: Void.
    - Related: StartNotifier.
```

--------------------------------

### OpenApplicationSettings

Source: https://api.essentialkit.voxelbusters.com/v3/d8/d19/class_voxel_busters_1_1_essential_kit_1_1_utilities-members

Opens the application's settings window. This allows users to access and modify application configurations directly.

```APIDOC
Utilities.OpenApplicationSettings()
  - Opens the application's settings window for user configuration.
  - Parameters: None
  - Returns: void
  - Static method.
```

--------------------------------

### LocalPlayerScore Property

Source: https://api.essentialkit.voxelbusters.com/v3/d0/d20/interface_voxel_busters_1_1_essential_kit_1_1_i_leaderboard

Gets the local player's score. This property is only valid after a score loading operation has completed.

```APIDOC
ILeaderboardScore LocalPlayerScore { get; }
Note: This property is invalid until a call to load scores is completed.
```

--------------------------------

### Create BillingProductOfferRedeemDetails Instance

Source: https://api.essentialkit.voxelbusters.com/v3/d6/ddd/class_voxel_busters_1_1_essential_kit_1_1_billing_product_offer_redeem_details

Demonstrates creating an instance of BillingProductOfferRedeemDetails using its builder, setting iOS platform properties, and then building the final object. It highlights the fluent interface for configuration.

```csharp
var offerRedeemDetails = new VoxelBusters.EssentialKit.BillingProductOfferRedeemDetails.Builder()
    .SetIosPlatformProperties("offerId", "keyId", "nonce", "signature", 123456)
    .SetAndroidPlatformProperties("offerId")
    .Build();
```

--------------------------------

### Get Scheduled Notifications

Source: https://api.essentialkit.voxelbusters.com/v3/da/d97/class_voxel_busters_1_1_essential_kit_1_1_notification_services

Retrieves a list of all currently scheduled notifications. The results are delivered via a callback containing a NotificationServicesGetScheduledNotificationsResult object.

```APIDOC
GetScheduledNotifications(EventCallback<NotificationServicesGetScheduledNotificationsResult> callback = null)
  - Parameters:
    - callback: Callback method that will be invoked after operation is completed.
  - References:
    - NotificationServices.ScheduledNotifications
```

```C#
static void GetScheduledNotifications(EventCallback<NotificationServicesGetScheduledNotificationsResult> callback = null);
```

--------------------------------

### Get Notification Settings

Source: https://api.essentialkit.voxelbusters.com/v3/da/d97/class_voxel_busters_1_1_essential_kit_1_1_notification_services

Retrieves the current settings for notification services. A callback is provided to handle the result, which includes information about the notification settings.

```APIDOC
GetSettings(Callback<NotificationServicesGetSettingsResult> callback = null)
  - Parameters:
    - callback: Callback method that will be invoked after operation is completed.
```

```C#
static void GetSettings(Callback<NotificationServicesGetSettingsResult> callback = null);
```

--------------------------------

### Utilities Class API Reference

Source: https://api.essentialkit.voxelbusters.com/v3/d7/d34/class_voxel_busters_1_1_essential_kit_1_1_utilities

Comprehensive documentation for the Utilities class, detailing its static methods for accessing native features. This includes initialization, opening app store pages with different parameters, and opening application settings.

```APIDOC
class VoxelBusters.EssentialKit.Utilities
{
    // Provides a cross-platform interface to access commonly used native features.

    // Initializes the utilities module with the given settings.
    // This call is optional and only need to be called if you have custom settings to initialize this feature.
    static void Initialize(UtilityUnitySettings settings)
    {
        // Parameters:
        // settings: The settings to be used for initialization. The settings configure the utilities module.
    }

    // Opens the app store website page associated with this app.
    static void OpenAppStorePage()
    {
        // No parameters.
        // Opens the app store website page associated with this app.
    }

    // Opens the app store page associated with the specified application id.
    // For iOS platform, id is the value that identifies your app on App Store. And on Android, it will be same as app's bundle identifier (com.example.test).
    static void OpenAppStorePage(params RuntimePlatformConstant[] applicationIds)
    {
        // Parameters:
        // applicationIds: An array of string values, that holds app id's of each supported platform.
        // Example Usage:
        // Utilities.OpenStoreLink(PlatformValue.Android("com.example.app"), PlatformValue.IOS("ios-app-id"));
    }

    // Opens the app store website page associated with the specified application id.
    static void OpenAppStorePage(string applicationId)
    {
        // Parameters:
        // applicationId: Application id.
    }

    // Opens the app settings page associated with this app.
    // For iOS platform, this will open the settings app to the app's custom settings page. On Android, this will open app's settings page in the device's settings app.
    static void OpenApplicationSettings()
    {
        // No parameters.
    }
}
```

--------------------------------

### VoxelBusters EssentialKit: BuyProductOptions Builder

Source: https://api.essentialkit.voxelbusters.com/v3/d1/d9e/class_voxel_busters_1_1_essential_kit_1_1_buy_product_options

Demonstrates the fluent API for building purchase request options. It shows how to set tags, quantities, and offer redeem details before finalizing the options object.

```csharp
var offerRedeemDetails = new VoxelBusters.EssentialKit.BillingProductOfferRedeemDetails.Builder()
    .SetIosPlatformProperties("offerId", "keyId", "nonce", "signature", 123456)
    .SetAndroidPlatformProperties("offerId")
    .Build();

var options = new VoxelBusters.EssentialKit.BuyProductOptions.Builder()
    .SetTag("your-uuid-v4-tag")
    .SetQuantity(2)
    .SetOfferRedeemDetails(offerRedeemDetails)
    .Build();
```

--------------------------------

### Example Usage: Network Status Event Handling

Source: https://api.essentialkit.voxelbusters.com/v3/dd/d14/class_voxel_busters_1_1_essential_kit_1_1_network_services

Demonstrates how to register for and handle network status change events in a Unity MonoBehaviour script.

```csharp
using UnityEngine;
using VoxelBusters.EssentialKit;

public class ExampleClass : MonoBehaviour
{
    private void OnEnable()
    {
        // registering for event
        NetworkServices.OnInternetConnectivityChange += OnInternetConnectivityChange;
        NetworkServices.OnHostReachabilityChange += OnHostReachabilityChange;
    }

    private void OnDisable()
    {
        // unregistering event
        NetworkServices.OnInternetConnectivityChange -= OnInternetConnectivityChange;
        NetworkServices.OnHostReachabilityChange -= OnHostReachabilityChange;
    }

    private void OnInternetConnectivityChange(NetworkServicesInternetConnectivityStatus data)
    {
        if (data.IsConnected)
        {
            // notify user that he/she is online
        }
        else
        {
            // notify user that he/she is offline
        }
    }

    private void OnHostReachabilityChange(NetworkServicesHostReachabilityStatus data)
    {
        Debug.Log("Host connectivity status: " + data.IsReachable);
    }
}
```

--------------------------------

### VoxelBusters EssentialKit: BuyProductOptions Builder API

Source: https://api.essentialkit.voxelbusters.com/v3/d1/d9e/class_voxel_busters_1_1_essential_kit_1_1_buy_product_options

API documentation for the BuyProductOptions Builder, detailing methods for configuring purchase requests such as setting tags, quantities, and offer details.

```APIDOC
VoxelBusters.EssentialKit.BuyProductOptions.Builder
  Builder class for BuyProductOptions.
  Definition: BuyProductOptions.cs:80

  SetTag(string tag)
    Sets a custom tag to be passed along with the purchase request.
    Parameters:
      tag: A string representing a custom tag (e.g., a UUID).
    Definition: BuyProductOptions.cs:99

  SetQuantity(int quantity)
    Sets the quantity to be purchased.
    Parameters:
      quantity: The number of items to purchase.
    Definition: BuyProductOptions.cs:119

  SetOfferRedeemDetails(BillingProductOfferRedeemDetails offerRedeemDetails)
    Sets the offer redeem details for the product offer.
    Parameters:
      offerRedeemDetails: An instance of BillingProductOfferRedeemDetails.
    Definition: BuyProductOptions.cs:131

  Build()
    Creates the BuyProductOptions instance.
    Returns: A configured BuyProductOptions object.
    Definition: BuyProductOptions.cs:146
```

--------------------------------

### Billing Services Initialization and Store Operations

Source: https://api.essentialkit.voxelbusters.com/v3/d0/d16/class_voxel_busters_1_1_essential_kit_1_1_billing_services

Methods for initializing the billing service and retrieving product information from the store. Initialization requires settings, while store initialization fetches product details and triggers an event upon completion.

```APIDOC
static void Initialize(BillingServicesUnitySettings settings)
  - Initializes the billing service with provided settings.
  - Parameters:
    - settings: The BillingServicesUnitySettings object containing configuration.
  - References:
    - BillingServices.OnInitializeStoreComplete
    - BillingServices.OnRestorePurchasesComplete
    - BillingServices.OnTransactionStateChange
    - BillingServices.Products

static void InitializeStore()
  - Retrieves product information configured in Billing Settings.
  - Your application uses this to present localized prices and information.
  - Note: When the request completes, BillingServices.OnInitializeStoreComplete is fired.
  - References:
    - BillingServices.InitializeStore()
    - BillingServicesUnitySettings.Products
```

--------------------------------

### BillingPeriod Class Documentation

Source: https://api.essentialkit.voxelbusters.com/v3/annotated

Represents the duration of a billing product subscription period. This class likely defines start and end dates or a duration value for subscriptions.

```APIDOC
BillingPeriod:
  Description: Represents duration of billing product subscription period.
  Namespace: voxel_busters::essential_kit
```

--------------------------------

### App Shortcut and Prompt Classes

Source: https://api.essentialkit.voxelbusters.com/v3/classes

Documentation for classes related to app shortcuts and prompt updates within the EssentialKit. Includes builder patterns for customization.

```APIDOC
AppShortcutItem.Builder:
  Description: Builder class for creating and configuring AppShortcutItem instances.
  Namespace: VoxelBusters.EssentialKit
  Link: d7/d48/class_voxel_busters_1_1_essential_kit_1_1_app_shortcut_item_1_1_builder.html

PromptUpdateOptions.Builder:
  Description: Builder class for configuring options related to prompt updates.
  Namespace: VoxelBusters.EssentialKit
  Link: db/d2b/class_voxel_busters_1_1_essential_kit_1_1_prompt_update_options_1_1_builder.html
```

--------------------------------

### IBillingProduct Interface

Source: https://api.essentialkit.voxelbusters.com/v3/hierarchy

Provides a cross-platform interface to access information about a product registered in the store. This includes details like product ID, price, and description.

```csharp
interface IBillingProduct {
    // Properties for product details like ID, Price, Description
}
```

--------------------------------

### Billing Environment and Subscription Status API

Source: https://api.essentialkit.voxelbusters.com/v3/da/d96/interface_voxel_busters_1_1_essential_kit_1_1_i_billing_transaction

Provides access to billing environment and subscription status. The 'get' method retrieves the current billing environment or the subscription status of a billing product.

```APIDOC
Environment:
  get()
    Returns: BillingEnvironment
    Description: Retrieves the billing environment.

SubscriptionStatus:
  get()
    Returns: BillingProductSubscriptionStatus
    Description: Retrieves the subscription status of the billing product.
```

--------------------------------

### Billing and Product Options Configuration

Source: https://api.essentialkit.voxelbusters.com/v3/functions_s

Methods for configuring billing-related options, including product offers and purchase details.

```APIDOC
BillingProductOfferRedeemDetails.Builder:
  SetIosPlatformProperties(properties: Dict)
    Sets platform-specific properties for redeeming iOS billing offers.

BuyProductOptions.Builder:
  SetOfferRedeemDetails(details: OfferRedeemDetails)
    Associates offer redemption details with the product purchase.

  SetQuantity(quantity: int)
    Sets the number of units to purchase.
```

--------------------------------

### CloudServices API Documentation

Source: https://api.essentialkit.voxelbusters.com/v3/d5/d7b/class_voxel_busters_1_1_essential_kit_1_1_cloud_services

Documentation for the CloudServices class, offering static methods to get, set, and manage data in a cloud store, along with event handlers for user and data changes.

```APIDOC
CloudServices Get Methods:

GetBool(string key)
  - Returns the boolean value associated with the specified key.
  - Parameters:
    - key: The key to retrieve the boolean value for.
  - Returns: The boolean value.

GetInt(string key)
  - Returns the integer value associated with the specified key.
  - Parameters:
    - key: The key to retrieve the integer value for.
  - Returns: The integer value.

GetLong(string key)
  - Returns the long value associated with the specified key.
  - Parameters:
    - key: The key to retrieve the long value for.
  - Returns: The long value.

GetFloat(string key)
  - Returns the float value associated with the specified key.
  - Parameters:
    - key: The key to retrieve the float value for.
  - Returns: The float value.

GetDouble(string key)
  - Returns the double value associated with the specified key.
  - Parameters:
    - key: The key to retrieve the double value for.
  - Returns: The double value.

GetString(string key)
  - Returns the string value associated with the specified key.
  - Parameters:
    - key: The key to retrieve the string value for.
  - Returns: The string value.

GetByteArray(string key)
  - Returns the array object associated with the specified key.
  - Parameters:
    - key: The key to retrieve the byte array for.
  - Returns: The byte array.

HasKey(string key)
  - Returns `true` if the key exists in the data snapshot.
  - Parameters:
    - key: The key to check for existence.
  - Returns: `true` if the key exists, `false` otherwise.
```

```APIDOC
CloudServices Set Methods:

SetBool(string key, bool value)
  - Sets a boolean value for the specified key in the cloud data store.
  - Parameters:
    - key: The key to set the boolean value for.
    - value: The boolean value to store.
  - Returns: void

SetInt(string key, int value)
  - Sets an integer value for the specified key in the cloud data store.
  - Parameters:
    - key: The key to set the integer value for.
    - value: The integer value to store.
  - Returns: void

SetLong(string key, long value)
  - Sets a long value for the specified key in the cloud data store.
  - Parameters:
    - key: The key to set the long value for.
    - value: The long value to store.
  - Returns: void

SetFloat(string key, float value)
  - Sets a float value for the specified key in the cloud data store.
  - Parameters:
    - key: The key to set the float value for.
    - value: The float value to store.
  - Returns: void

SetDouble(string key, double value)
  - Sets a double value for the specified key in the cloud data store.
  - Parameters:
    - key: The key to set the double value for.
    - value: The double value to store.
  - Returns: void

SetString(string key, string value)
  - Sets a string value for the specified key in the cloud data store.
  - Parameters:
    - key: The key to set the string value for.
    - value: The string value to store.
  - Returns: void

SetByteArray(string key, byte[] value)
  - Sets an array object for the specified key in the cloud data store.
  - Parameters:
    - key: The key to set the byte array for.
    - value: The byte array to store.
  - Returns: void
```

```APIDOC
CloudServices Actions:

Synchronize(Callback<CloudServicesSynchronizeResult> callback = null)
  - Explicitly synchronizes in-memory data with those stored on disk.
  - Parameters:
    - callback: An optional callback function to be invoked upon completion of the synchronization.
  - Returns: void

RemoveKey(string key)
  - Removes the value associated with the specified key from the cloud data store.
  - Parameters:
    - key: The key whose value should be removed.
  - Returns: void
```

```APIDOC
CloudServices Events:

OnUserChange
  - Event that will be called when cloud user changed.
  - Signature: EventCallback<CloudServicesUserChangeResult>

OnSavedDataChange
  - Event that will be called when the value of one or more keys in the local key-value store changed due to incoming data pushed from cloud.
  - Signature: Callback<CloudServicesSavedDataChangeResult>
  - Related: Synchronize, Set methods

OnSynchronizeComplete
  - Event that will be called when the synchronize request is finished.
  - Signature: Callback<CloudServicesSynchronizeResult>
  - Related: Synchronize
```

--------------------------------

### AppShortcuts API Documentation

Source: https://api.essentialkit.voxelbusters.com/v3/da/d29/class_voxel_busters_1_1_essential_kit_1_1_app_shortcuts

Provides methods for initializing, adding, and removing application shortcuts. It leverages platform-specific libraries for iOS and Android. Includes properties for accessing settings and events for shortcut interactions.

```APIDOC
VoxelBusters.EssentialKit.AppShortcuts

Description:
  The AppShortcuts feature allows the creation of shortcuts for the application. It uses Quick Actions and App Shortcuts libraries internally on iOS and Android platforms respectively.

Static Public Member Functions:

  static void Initialize(AppShortcutsUnitySettings settings)
    Description: Initialize the App Shortcuts module with the given settings. This call is optional and only needs to be called if you have custom settings to initialize this feature.
    Parameters:
      settings: The settings to be used for initialization. The settings configure the behavior of the App Shortcuts module.
    References: AppShortcuts.OnShortcutClicked, AppShortcuts.UnitySettings

  static void Add(AppShortcutItem item)
    Description: Adds an app shortcut.
    Parameters:
      item: The item to be added. Pass an instance of AppShortcutItem class which is created with AppShortcutItem.Builder.

  static void Remove(string shortcutItemId)
    Description: Removes an app shortcut.
    Parameters:
      shortcutItemId: The identifier of the shortcut to be removed.

Properties:

  static AppShortcutsUnitySettings UnitySettings { get; }
    Description: The settings used for initialization.

Events:

  static Callback<string> OnShortcutClicked
    Description: Fired when a shortcut is clicked and provides the shortcut identifier to identify the shortcut.
```

--------------------------------

### AddressBookUnitySettings Class Members

Source: https://api.essentialkit.voxelbusters.com/v3/d0/d68/class_voxel_busters_1_1_essential_kit_1_1_address_book_unity_settings-members

Documentation for the AddressBookUnitySettings class, detailing its constructor and members. Includes parameter types and descriptions.

```APIDOC
AddressBookUnitySettings:
  // Constructor
  AddressBookUnitySettings(bool isEnabled = true)
    // Parameters:
    //   isEnabled: A boolean indicating if the address book is enabled (defaults to true).

  // Member Variable
  DefaultImage: // Type inferred as potentially an image asset or path
    // Description: Represents the default image associated with the address book settings.
```

--------------------------------

### PromptUpdateOptions Class Properties

Source: https://api.essentialkit.voxelbusters.com/v3/d5/d7f/class_voxel_busters_1_1_essential_kit_1_1_prompt_update_options

Details the properties available for configuring user update prompts within the Essential Kit. This includes mandatory update flags, prompt titles and messages, and conditions for installing downloaded updates.

```APIDOC
PromptUpdateOptions:
  Description: Represents the options for prompting an update to the user.

  Properties:
    IsForceUpdate: bool [get]
      Description: Gets a value indicating whether the update is mandatory.

    Title: string [get]
      Description: Gets the title of the update prompt.

    Message: string [get]
      Description: Gets the message of the update prompt.

    AllowInstallationIfDownloaded: bool [get] = true
      Description: Gets a value indicating whether the update can be installed if it has already been downloaded.
      Notes:
        - Default value is true
        - If force update is enabled, this option will be considered as true.
```

--------------------------------

### IBillingProduct Interface Documentation

Source: https://api.essentialkit.voxelbusters.com/v3/d0/d57/interface_voxel_busters_1_1_essential_kit_1_1_i_billing_product

Provides a cross-platform interface to access information about a product registered in the Store. It exposes properties for product identification, localized details, pricing, availability, and subscription information.

```APIDOC
IBillingProduct Interface
  Namespace: VoxelBusters.EssentialKit
  Description: Provides a cross-platform interface to access information about a product registered in Store.

  Properties:
    Id:
      Type: string
      Access: [get]
      Description: The string that identifies the product within Unity environment. (read-only)

    PlatformId:
      Type: string
      Access: [get]
      Description: The string that identifies the product registered in the Store (platform specific). (read-only)

    LocalizedTitle:
      Type: string
      Access: [get]
      Description: The name of the product.

    LocalizedDescription:
      Type: string
      Access: [get]
      Description: A description of the product.

    Type:
      Type: BillingProductType
      Access: [get]
      Description: The type of the product.
      Reference: ../../da/d57/namespace_voxel_busters_1_1_essential_kit.html#a8a4514d4d8550dedff67772e8a230121

    Price:
      Type: BillingPrice
      Access: [get]
      Description: The cost of the product.
      Reference: ../../df/df5/class_voxel_busters_1_1_essential_kit_1_1_billing_price.html

    IsAvailable:
      Type: bool
      Access: [get]
      Description: Determine whether the product can be purchased.

    SubscriptionInfo:
      Type: BillingProductSubscriptionInfo
      Access: [get]
      Description: Gets the subscription information for a billing product.
      Reference: ../../df/d2b/class_voxel_busters_1_1_essential_kit_1_1_billing_product_subscription_info.html

    Payouts:
      Type: IEnumerable<BillingProductPayoutDefinition>
      Access: [get]
      Description: The Additional information associated with this product.
      Reference: ../../d7/d25/class_voxel_busters_1_1_essential_kit_1_1_billing_product_payout_definition.html

    LocalizedPrice:
      Type: string
      Access: [get]
      Description: The cost of the product prefixed with local currency symbol.

    PriceCurrencyCode:
      Type: string
      Access: [get]
      Description: The currency code of the price.

    PriceCurrencySymbol:
      Type: string
      Access: [get]
      Description: Gets the currency symbol for the price.

    Tag:
      Type: object
      Access: [get]
      Description: Additional information associated with this product. This information is provided by the developer using BillingProductDefinition.Tag property.
```

--------------------------------

### Raw Data Retrieval API

Source: https://api.essentialkit.voxelbusters.com/v3/da/d96/interface_voxel_busters_1_1_essential_kit_1_1_i_billing_transaction

Accesses raw transaction data. The 'get' method returns a string containing transaction details, including a 'transaction' key identifier. On Android, it also includes a 'signature' key.

```APIDOC
RawData:
  get()
    Returns: string
    Description: Contains transaction details with "transaction" key identifier. On Android, additionally contains "signature" key identifier.
```

--------------------------------

### DeepLinkServices API

Source: https://api.essentialkit.voxelbusters.com/v3/de/df5/class_voxel_busters_1_1_essential_kit_1_1_deep_link_services

Provides a cross-platform interface to handle deep links. Includes methods for initialization and events for tracking link openings.

```APIDOC
class DeepLinkServices {
  // Initializes the DeepLinkServices module with the given settings.
  // This call is optional and only needs to be called if you have custom settings.
  // Parameters:
  //   settings: The settings to be used for initialization.
  static void Initialize(DeepLinkServicesUnitySettings settings)

  // Event that will be called when a URL scheme is opened.
  // Type: Callback<DeepLinkServicesDynamicLinkOpenResult>
  static Callback<DeepLinkServicesDynamicLinkOpenResult> OnCustomSchemeUrlOpen

  // Event that will be called when a universal link is opened.
  // Type: Callback<DeepLinkServicesDynamicLinkOpenResult>
  static Callback<DeepLinkServicesDynamicLinkOpenResult> OnUniversalLinkOpen
}
```

--------------------------------

### WebView Class Methods

Source: https://api.essentialkit.voxelbusters.com/v3/dc/d16/class_voxel_busters_1_1_essential_kit_1_1_web_view-members

Documentation for the methods of the WebView class, which manages web content display. This includes methods for controlling loading, scaling, and accessing properties like URL and title.

```APIDOC
WebView Class Methods:

ScalesPageToFit()
  - Scales the web page content to fit the available view area.
  - Parameters: None
  - Returns: void

Show()
  - Displays the WebView.
  - Parameters: None
  - Returns: void

StopLoading()
  - Stops the current web page loading process.
  - Parameters: None
  - Returns: void

Style()
  - Applies or retrieves styling properties for the WebView.
  - Parameters: None (assumed, specific styling parameters not detailed in source)
  - Returns: void (or styling object, not detailed in source)

Title()
  - Retrieves the title of the current web page.
  - Parameters: None
  - Returns: string (the page title)

URL()
  - Retrieves the URL of the current web page.
  - Parameters: None
  - Returns: string (the page URL)
```

--------------------------------

### Get Data Methods

Source: https://api.essentialkit.voxelbusters.com/v3/d5/d7b/class_voxel_busters_1_1_essential_kit_1_1_cloud_services

Retrieves data from the cloud data store based on a provided key. Supports fetching string values and byte arrays. Returns null if the key is not found or the value type does not match.

```APIDOC
GetString(string key)
  - Returns: The string associated with the specified key, or null if the key was not found or its value is not a string.
  - Parameters:
    - key: A string used to identify the value stored in the cloud data store.
  - Referenced by: CloudServicesUtility.TryGetCloudAndLocalCacheValues<T>()

GetByteArray(string key)
  - Returns: Array object associated with the specified key, or null if the key was not found or its value is not an Array object.
  - Parameters:
    - key: A string used to identify the value stored in the cloud data store.
  - Referenced by: CloudServicesUtility.TryGetCloudAndLocalCacheValues<T>()
```

--------------------------------

### CloudServices Static Methods

Source: https://api.essentialkit.voxelbusters.com/v3/d2/d36/class_voxel_busters_1_1_essential_kit_1_1_cloud_services-members

This section details the static methods available in the CloudServices class for interacting with cloud data. It covers methods for getting and setting various data types, checking for key existence, removing keys, and handling synchronization events.

```APIDOC
CloudServices:
  // Retrieves a boolean value associated with the given key.
  GetBool(key: string): bool
    - key: The identifier for the boolean value.
    - Returns: The boolean value stored, or a default if not found.

  // Retrieves a byte array associated with the given key.
  GetByteArray(key: string): byte[]
    - key: The identifier for the byte array.
    - Returns: The byte array stored, or null if not found.

  // Retrieves a double-precision floating-point value associated with the given key.
  GetDouble(key: string): double
    - key: The identifier for the double value.
    - Returns: The double value stored, or a default if not found.

  // Retrieves a single-precision floating-point value associated with the given key.
  GetFloat(key: string): float
    - key: The identifier for the float value.
    - Returns: The float value stored, or a default if not found.

  // Retrieves an integer value associated with the given key.
  GetInt(key: string): int
    - key: The identifier for the integer value.
    - Returns: The integer value stored, or a default if not found.

  // Retrieves a long integer value associated with the given key.
  GetLong(key: string): long
    - key: The identifier for the long integer value.
    - Returns: The long integer value stored, or a default if not found.

  // Retrieves a string value associated with the given key.
  GetString(key: string): string
    - key: The identifier for the string value.
    - Returns: The string value stored, or null if not found.

  // Checks if a key exists in the cloud storage.
  HasKey(key: string): bool
    - key: The identifier to check for.
    - Returns: True if the key exists, false otherwise.

  // Event triggered when saved data changes.
  OnSavedDataChange(): void
    - Description: Callback for changes in saved data.

  // Event triggered when synchronization is complete.
  OnSynchronizeComplete(): void
    - Description: Callback for synchronization completion.

  // Event triggered when the user changes.
  OnUserChange(): void
    - Description: Callback for user changes.

  // Removes a key and its associated value from cloud storage.
  RemoveKey(key: string): void
    - key: The identifier of the key to remove.

  // Sets a boolean value associated with the given key.
  SetBool(key: string, value: bool): void
    - key: The identifier for the boolean value.
    - value: The boolean value to store.

  // Sets a byte array value associated with the given key.
  SetByteArray(key: string, value: byte[]): void
    - key: The identifier for the byte array.
    - value: The byte array to store.

  // Sets a double-precision floating-point value associated with the given key.
  SetDouble(key: string, value: double): void
    - key: The identifier for the double value.
    - value: The double value to store.

  // Sets a single-precision floating-point value associated with the given key.
  SetFloat(key: string, value: float): void
    - key: The identifier for the float value.
    - value: The float value to store.

  // Sets an integer value associated with the given key.
  SetInt(key: string, value: int): void
    - key: The identifier for the integer value.
    - value: The integer value to store.

  // Sets a long integer value associated with the given key.
  SetLong(key: string, value: long): void
    - key: The identifier for the long integer value.
    - value: The long integer value to store.

  // Sets a string value associated with the given key.
  SetString(key: string, value: string): void
    - key: The identifier for the string value.
    - value: The string value to store.
```

--------------------------------

### MediaContentSelectOptions Constructor and Properties

Source: https://api.essentialkit.voxelbusters.com/v3/df/dd4/class_voxel_busters_1_1_essential_kit_1_1_media_content_select_options

Details the constructor for MediaContentSelectOptions and its core properties: Title, AllowedMimeType, and MaxAllowed. The constructor initializes a new instance with specified parameters.

```APIDOC
MediaContentSelectOptions:
  __init__(title: string, allowedMimeType: string, maxAllowed: int)
    Initializes a new instance of the MediaContentSelectOptions class.
    Parameters:
      title: Title.
      allowedMimeType: Allowed mime type.
      maxAllowed: Max allowed contents to select.

  Properties:
    Title: string [get]
      Gets the title which is shown to user.
    AllowedMimeType: string [get]
      Gets the allowed mime type.
    MaxAllowed: int [get]
      Gets the max allowed.
```

--------------------------------

### Essential Kit Functions

Source: https://api.essentialkit.voxelbusters.com/v3/functions_func_p

Lists key functions available in the Essential Kit API, with links to their respective class documentation for detailed information on parameters, return values, and usage.

```APIDOC
PromptUpdate()
  - Description: Updates the prompt.
  - Related Class: AppUpdater
  - Link: d1/d4f/class_voxel_busters_1_1_essential_kit_1_1_app_updater.html#abc91bdb44be29f2a8113cf81fab2daf4

PushNotificationTrigger()
  - Description: Triggers a push notification.
  - Related Class: PushNotificationTrigger
  - Link: df/d80/class_voxel_busters_1_1_essential_kit_1_1_push_notification_trigger.html#a82edfeb0cac8fb3ae92e2f8571cec0aa
```

--------------------------------

### CloudServicesUtility TryGetCloudAndLocalCacheValues Method

Source: https://api.essentialkit.voxelbusters.com/v3/d1/da8/class_voxel_busters_1_1_essential_kit_1_1_cloud_services_utility

Retrieves values from both cloud storage and local cache for a given key. It handles generic types and provides a default value for local cache if the key is not found. This method relies on various Get methods from the CloudServices class.

```APIDOC
CloudServicesUtility::TryGetCloudAndLocalCacheValues<T>

Signature:
  static bool TryGetCloudAndLocalCacheValues<T>(string key, out T cloudValue, out T localCacheValue, T localCacheDefaultValue = default)

Template Parameters:
  T: Specify the type of the value stored in cloud.

Parameters:
  key: string used to identify the value stored in the cloud data store.
  cloudValue: The value available in Cloud storage. (Output parameter)
  localCacheValue: The value available in local cache. (Output parameter)
  localCacheDefaultValue: The default value to be used when specified key doesn't exist in local cache.

Returns:
  bool: Indicates success or failure of the operation (details not specified).

References:
  - CloudServices.GetBool()
  - CloudServices.GetByteArray()
  - CloudServices.GetDouble()
  - CloudServices.GetFloat()
  - CloudServices.GetInt()
  - CloudServices.GetLong()
  - CloudServices.GetString()
```

--------------------------------

### NotificationServices Result Classes API

Source: https://api.essentialkit.voxelbusters.com/v3/da/d57/namespace_voxel_busters_1_1_essential_kit

This group of classes represents the results returned by various methods within the NotificationServices class. They contain the data retrieved from operations such as registering for push notifications, requesting permissions, getting delivered or scheduled notifications, and retrieving system settings.

```APIDOC
class NotificationServicesRegisterForPushNotificationsResult
  // This class contains the information retrieved when NotificationServices.RegisterForPushNotifications(...) operation is completed.
  // Properties:
  //   IsSuccess: bool
  //   ErrorMessage: string
  //   DeviceToken: string // The push notification token for the device.

class NotificationServicesRequestPermissionResult
  // This class contains the information retrieved when NotificationServices.RequestPermission(...) is completed.
  // Properties:
  //   IsSuccess: bool
  //   ErrorMessage: string
  //   PermissionStatus: NotificationPermissionStatus // Enum indicating the granted permission status.

class NotificationServicesGetSettingsResult
  // This class contains the information retrieved when NotificationServices.GetSettings(...) is completed.
  // Properties:
  //   IsSuccess: bool
  //   ErrorMessage: string
  //   AuthorizationStatus: AuthorizationStatus // Enum indicating the authorization status for notifications.

class NotificationServicesGetDeliveredNotificationsResult
  // This class contains the information retrieved when NotificationServices.GetDeliveredNotifications(...) request is completed.
  // Properties:
  //   IsSuccess: bool
  //   ErrorMessage: string
  //   DeliveredNotifications: List<DeliveredNotification> // List of delivered notifications.

class NotificationServicesGetScheduledNotificationsResult
  // This class contains the information retrieved when NotificationServices.GetScheduledNotifications(...) request is completed.
  // Properties:
  //   IsSuccess: bool
  //   ErrorMessage: string
  //   ScheduledNotifications: List<ScheduledNotification> // List of scheduled notifications.

class NotificationServicesNotificationReceivedResult
  // This class contains the information retrieved when notification message is received.
  // Properties:
  //   Title: string
  //   Body: string
  //   Data: Dictionary<string, string>
  //   IsSilent: bool
```

--------------------------------

### AddressBookUnitySettings Class Configuration (C#)

Source: https://api.essentialkit.voxelbusters.com/v3/d8/d8d/class_voxel_busters_1_1_essential_kit_1_1_address_book_unity_settings

Documentation for the AddressBookUnitySettings class, used to configure the Address Book module of the Essential Kit. It includes details on its constructor and properties.

```APIDOC
AddressBookUnitySettings
  The AddressBookUnitySettings class is used to configure Address Book module of Essential Kit.

  Constructor:
    AddressBookUnitySettings(bool isEnabled = true)
      Initializes a new instance of the AddressBookUnitySettings class with the specified settings.
      Parameters:
        isEnabled: bool - if set to true, the module is enabled.

  Properties:
    DefaultImage: Texture2D [get]
      Gets the default image to be used for contact.
```

--------------------------------

### CloudServices Synchronize Method

Source: https://api.essentialkit.voxelbusters.com/v3/d2/d36/class_voxel_busters_1_1_essential_kit_1_1_cloud_services-members

Provides documentation for the static Synchronize method within the CloudServices class. This method is used to synchronize cloud services, accepting an optional callback for asynchronous operations. Detailed parameter descriptions, return values, and usage examples are typically found in the linked Doxygen documentation.

```APIDOC
CloudServices:
  Synchronize(callback: Callback<CloudServicesSynchronizeResult> = null)
    - Description: Synchronizes cloud services.
    - Parameters:
      - callback: An optional callback function to handle the synchronization result.
    - Returns: void (asynchronous operation, result handled by callback)
    - Static: true
    - Related: Other methods within the CloudServices class.
```

--------------------------------

### AddressBook Initialization

Source: https://api.essentialkit.voxelbusters.com/v3/da/db1/class_voxel_busters_1_1_essential_kit_1_1_address_book

Initializes the address book module with optional custom settings. This call is not mandatory if default settings are sufficient.

```APIDOC
static void Initialize(AddressBookUnitySettings settings)
  [Advanced] Initializes the address book module with the given settings.

  Parameters:
    settings: The settings to be used for initialization. This configures the default image to be used for address book contacts.

  References:
    AddressBookUnitySettings.DefaultImage
```

--------------------------------

### Compose and Send Text Message using VoxelBusters EssentialKit

Source: https://api.essentialkit.voxelbusters.com/v3/d1/d0b/class_voxel_busters_1_1_essential_kit_1_1_message_composer

This C# code example demonstrates how to use the MessageComposer class to create and display a text message interface. It checks if the device supports sending text messages, initializes the composer, sets the message body, registers a completion callback, and shows the composer.

```C#
using UnityEngine;
using System.Collections;
using VoxelBusters.EssentialKit;

public class ExampleClass : MonoBehaviour
{
    public void Start()
    {
        if (MessageComposer.CanSendText())
        {
            // create new instance and populate fields
            MessageComposer newComposer = MessageComposer.CreateInstance();
            newComposer.SetBody("Lorem ipsum dolor sit amet");
            newComposer.SetCompletionCallback(OnMessageComposerClosed);
            newComposer.Show();
        }
        else
        {
            // device doesn't support sending emails
        }
    }

    private void OnMessageComposerClosed(MessageComposerResult result, Error error)
    {
        // add your code
    }
}
```

--------------------------------

### Prompting and User Interaction

Source: https://api.essentialkit.voxelbusters.com/v3/annotated

Classes related to prompting users for updates or reviews, and handling raw media data.

```APIDOC
PromptUpdateOptions:
  Represents the options for prompting an update to the user.
  Use the PromptUpdateOptions.Builder to create an instance of this class.

PromptUpdateOptions.Builder:
  Builder class for constructing PromptUpdateOptions instances.

RateMyApp:
  Unique way to prompt user to review the app.

RateMyAppLocalisationKey:
  Keys used to localize the rate my app feature.

RawMediaData:
  Contains information about raw media data.
```

--------------------------------

### VoxelBusters EssentialKit: Core Data Structures

Source: https://api.essentialkit.voxelbusters.com/v3/d1/d9e/class_voxel_busters_1_1_essential_kit_1_1_buy_product_options

Documentation for the core data structures used in purchase requests, including details for offer redemption and general purchase options.

```APIDOC
VoxelBusters.EssentialKit.BillingProductOfferRedeemDetails
  Represents details of a product offer to be redeemed.
  Definition: BillingProductOfferRedeemDetails.cs:18

VoxelBusters.EssentialKit.BuyProductOptions
  Represents options for purchasing a IBillingProduct.
  Definition: BuyProductOptions.cs:28
```

--------------------------------

### AppUpdater Class Methods

Source: https://api.essentialkit.voxelbusters.com/v3/d4/d70/class_voxel_busters_1_1_essential_kit_1_1_app_updater-members

Provides documentation for the static methods of the AppUpdater class, including initialization, prompting for updates, and requesting update information. These methods are part of the Essential Kit.

```APIDOC
AppUpdater:
  // Static methods for managing application updates.

  Initialize(settings: AppUpdaterUnitySettings)
    - Initializes the AppUpdater with provided settings.
    - Parameters:
      - settings: AppUpdaterUnitySettings - The settings object for initialization.
    - Returns: void

  PromptUpdate(options: PromptUpdateOptions, callback: EventCallback< float >)
    - Prompts the user to update the application based on the provided options.
    - Parameters:
      - options: PromptUpdateOptions - Configuration for the update prompt.
      - callback: EventCallback< float > - A callback function that receives a float value (e.g., progress).
    - Returns: void

  RequestUpdateInfo(callback: EventCallback< AppUpdaterUpdateInfo >)
    - Requests information about available application updates.
    - Parameters:
      - callback: EventCallback< AppUpdaterUpdateInfo > - A callback function that receives AppUpdaterUpdateInfo object containing update details.
    - Returns: void

  // Related Classes/Structs:
  // AppUpdaterUnitySettings: Configuration settings for AppUpdater.
  // PromptUpdateOptions: Options to customize the update prompt behavior.
  // AppUpdaterUpdateInfo: Structure containing information about available updates.
  // EventCallback<T>: Generic callback type for asynchronous operations.
```