Appzi.AddIn 0.0.4

Appzi.AddIn

Overview

Appzi.AddIn is a .NET library for integrating Appzi survey functionality into .NET applications using WebView2.

Features

• Embedded Surveys: Integrate surveys within your application.
• Floating Surveys: Display surveys in separate windows.
• Automatic Survey Targeting: Conditionally display surveys.

Installation

Install the package via NuGet:

Install-Package Appzi.AddIn

Or using the .NET CLI:

dotnet add package Appzi.AddIn

Requirements

• .NET Framework 4.8.1 or higher
• Dependencies:
  • Microsoft.Web.WebView2 (1.0.3124.44 or higher)
  • Newtonsoft.Json (13.0.3 or higher)

Usage Examples

Basic Survey Integration

// Initialize a basic embedded survey
var survey = new Appzi.AddIn.Components.AppziSurvey();
survey.SurveyId = new Guid("YOUR_SURVEY_ID");

// Add to your WPF or Windows Forms container
yourContainer.Content = survey;

// Handle survey events
survey.SurveyEvents += (sender, args) => {
    switch(args.EventType) {
        case AppziBridgeEventType.Submitted:
            // Handle survey submission
            break;
        case AppziBridgeEventType.Dismissed:
            // Handle survey dismissal
            break;
    }
};

WPF/XAML Example

<Window x:Class="YourNamespace.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:appzi="clr-namespace:Appzi.AddIn.Components"
        Title="MainWindow" Height="450" Width="800">
    <Grid>
        <appzi:AppziSurvey x:Name="SurveyControl" SurveyId="YOUR_SURVEY_ID" />
    </Grid>
</Window>

Floating Survey Window

using System.Windows;
using System.Windows.Interop;

// Create a class that implements IAppziApplicationHost
public class MyAppHost : IAppziApplicationHost
{
    private readonly Window _wpfWindow;

    public MyAppHost(Window wpfWindow)
    {
        _wpfWindow = wpfWindow;
    }

    public int HWND
    {
        get
        {
            // Extract the handle from the WPF window passed in constructor
            return new WindowInteropHelper(_wpfWindow).Handle.ToInt32();
            // Example for WinForms
            // return yourForm.Handle.ToInt32();

            // Example for Office applications
            // return applicationObject.HWND;
        }
    }
}

// Initialize and show a floating survey
var appHost = new MyAppHost(Application.Current.MainWindow);
var floatingSurvey = new AppziFloatingSurvey(appHost);
floatingSurvey.OpenSurvey(new Guid("YOUR_SURVEY_ID"));

Automatic Survey Targeting

// Initialize the targeting engine
AppziAutomaticSurveyEngine.Initialize(yourAppHost);
var engine = AppziAutomaticSurveyEngine.GetInstance();

// Set targeting data
engine.Data
    .Set("userType", "premium")
    .Set("visitCount", 5)
    .Set("lastVisit", DateTime.Now.AddDays(-7));

// Activate the engine to evaluate survey display rules
engine.Activate();

Architecture

The library is composed of several key components:

• AppziSurvey: A WPF UserControl for hosting the survey interface.
• AppziFloatingSurvey: Manages a floating window with survey content.
• AppziAutomaticSurveyEngine: A singleton for automatic survey targeting.
• AppziData: A data structure for collecting and formatting survey data.

License

This package is licensed under the MIT License.

Support

For additional support, please visit the Appzi website or contact support@appzi.com.