SamplePlugin.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Microsoft.Extensions.Logging;
using TouchPortalSDK.Interfaces;
using TouchPortalSDK.Messages.Events;
using TouchPortalSDK.Messages.Models;
using TouchPortalSDK.Messages.Models.Enums;

namespace TouchPortalSDK.Sample
{
    public class SamplePlugin : ITouchPortalEventHandler
    {
        public string PluginId => "TouchPortalSDK.Sample";

        private readonly ILogger<SamplePlugin> _logger;
        private readonly ITouchPortalClient _client;

        private IReadOnlyCollection<Setting> _settings;

        public SamplePlugin(ITouchPortalClientFactory clientFactory,
                            ILogger<SamplePlugin> logger)
        {
            _logger = logger;
            _client = clientFactory.Create(this);
        }

        public void Run()
        {
            //Connect to Touch Portal:
            _client.Connect();

            //Start sending messages:
            SendMessages();
        }

        public void OnClosedEvent(string message)
        {
            _logger?.LogInformation("TouchPortal Disconnected.");

            //Optional force exits this plugin.
            Environment.Exit(0);
        }

        //Send messages for testing.
        private void SendMessages()
        {
            //Update choices (dropdown in UI when creating an action):
            _client.ChoiceUpdate("category1.action1.data2", new[] { "choice 1 (updated)", "choice 2 (updated)", "choice 3 (updated)" });

            //Removes a dynamic state (no change if state does not exist):
            _client.RemoveState("dynamicState1");

            //Adds a state we can work with:
            _client.CreateState("dynamicState1", "Test dynamic state 1", "Test 123");

            //Updates the created dynamic state, if you do not create it:
            _client.StateUpdate("dynamicState1", "d1");

            //You can display this value, but it will not appear in any list:
            _client.StateUpdate("dynamicState2", "d2");

            //Updates the static state (entry.tp):
            _client.StateUpdate("category1.staticstate1", "s1");

            //Custom states (Global Objects/left panel in Touch Portal UI), user adds this (states.tp in %AppData%/TouchPortal).
            //The user should add this manually in the UI:
            _client.StateUpdate("global.customState1", "c2");

            //Updates settings in Touch Portal settings:
            _client.SettingUpdate("Test3", DateTime.UtcNow.ToString("yyyyMMddHHmmss"));

            //Updates the min and max value of the number field.
            _client.UpdateActionData("category1.action1.data4", 10, 15, ActionDataType.Number);

            //Sends a notification to the Touch Portal UI this needs options the user can react on:
            _client.ShowNotification($"TouchPortal.SamplePlugin|update", "SamplePlugin: new version", "Please update to version 1.0!", new[] {
                new NotificationOptions { Id = "update", Title = "Update this plugin" },
                new NotificationOptions { Id = "readMore", Title = "Read more..." }
            });

            //Updates a connector/slider value.
            _client.ConnectorUpdate("dotnetsample001", 10);

            //Updates the connector with data, however this seems buggy, and we would need to find a more automated way of doing this.
            var message = JsonSerializer.Serialize(new
            {
                type = "connectorUpdate",
                connectorId = $"pc_{PluginId}_dotnetsample002|connectordata001=test", //If you change the value in Touch Portal UI, this also need to be changed (and the page on the touch device might need to be refreshed).
                value = 20
            });
            _client.SendMessage(message);

            //_client.Close()
        }

        /// <summary>
        /// Information received when plugin is connected to Touch Portal.
        /// </summary>
        /// <param name="message"></param>
        public void OnInfoEvent(InfoEvent message)
        {
            _logger?.LogInformation($"[Info] VersionCode: '{message.TpVersionCode}', VersionString: '{message.TpVersionString}', SDK: '{message.SdkVersion}', PluginVersion: '{message.PluginVersion}', Status: '{message.Status}'");

            _settings = message.Settings;
            _logger?.LogInformation($"[Info] Settings: {JsonSerializer.Serialize(_settings)}");
        }

        /// <summary>
        /// User selected an item in a dropdown menu in the Touch Portal UI.
        /// </summary>
        /// <param name="message"></param>
        public void OnListChangedEvent(ListChangeEvent message)
        {
            _logger?.LogInformation($"[OnListChanged] {message.ListId}/{message.ActionId}/{message.InstanceId} '{message.Value}'");

            switch (message.ListId)
            {
                //Dynamically updates the dropdown of data3 based on value chosen from data2 dropdown:
                case "category1.action1.data2" when message.InstanceId is not null:
                    var prefix = message.Value;
                    _client.ChoiceUpdate("category1.action1.data3", new[] { $"{prefix} second 1", $"{prefix} second 2", $"{prefix} second 3" }, message.InstanceId);
                    break;
            }
        }

        /// <summary>
        /// A broadcast event was received.
        /// </summary>
        /// <param name="message"></param>
        public void OnBroadcastEvent(BroadcastEvent message)
        {
            //Use this to reapply all state... Some times if you update the state, and the page is not visible, it will not be reflected in the app.
            _logger?.LogInformation($"[Broadcast] Event: '{message.Event}', PageName: '{message.PageName}'");
        }

        /// <summary>
        /// Updated settings was received.
        /// </summary>
        /// <param name="message"></param>
        public void OnSettingsEvent(SettingsEvent message)
        {
            _settings = message.Values;
            _logger?.LogInformation($"[OnSettings] Settings: {JsonSerializer.Serialize(_settings)}");
        }

        /// <summary>
        /// User clicked an action.
        /// </summary>
        /// <param name="message"></param>
        public void OnActionEvent(ActionEvent message)
        {
            switch (message.ActionId)
            {
                case "category1.action1":
                    //Get data with indexer:
                    var data1 = message["category1.action1.data1"] ?? "<null>";
                    var data2 = message["category1.action1.data2"] ?? "<null>";
                    var data3 = message["category1.action1.data3"] ?? "<null>";
                    var data4 = message["category1.action1.data4"] ?? "<null>";
                    //Get date with method:
                    var data5 = message.GetValue("category1.action1.data5") ?? "<null>";
                    var data6 = message.GetValue("category1.action1.data6") ?? "<null>";
                    var data7 = message.GetValue("category1.action1.data7") ?? "<null>";
                    var data8 = message.GetValue("category1.action1.data8") ?? "<null>";
                    _logger?.LogInformation($"[OnAction] PressState: {message.GetPressState()}, ActionId: {message.ActionId}, Data: data1:'{data1}', data2:'{data2}', data3:'{data3}', data4:'{data4}', data5:'{data5}', data6:'{data6}', data7:'{data7}', data8:'{data8}'");
                    break;

                default:
                    var dataArray = message.Data
                        .Select(dataItem => $"\"{dataItem.Key}\":\"{dataItem.Value}\"")
                        .ToArray();

                    var dataString = string.Join(", ", dataArray);
                    _logger?.LogInformation($"[OnAction] PressState: {message.GetPressState()}, ActionId: {message.ActionId}, Data: '{dataString}'");
                    break;
            }
        }

        /// <summary>
        /// Here you can react on what the person clicked in the option.
        /// </summary>
        /// <param name="message"></param>
        public void OnNotificationOptionClickedEvent(NotificationOptionClickedEvent message)
        {
            _logger?.LogInformation($"[OnNotificationOptionClickedEvent] NotificationId: '{message.NotificationId}', OptionId: '{message.OptionId}'");

            if (message.NotificationId is "TouchPortal.SamplePlugin|update")
            {
                switch (message.OptionId)
                {
                    //Example for opening a web browser (windows):
                    case "update":
                        System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo
                        {
                            UseShellExecute = true,
                            FileName = "https://www.nuget.org/packages/TouchPortalSDK/"
                        });
                        break;
                    case "readMore":
                        System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo
                        {
                            UseShellExecute = true,
                            FileName = "https://github.com/oddbear/TouchPortalSDK/"
                        });
                        break;
                }
            }
        }

        /// <summary>
        /// Event fired when the TP user moves a slider which uses one of this plugin's Connectors.
        /// This event is very similar to the OnActionEvent but with a `Value` attribute reflecting the slider's
        /// current position. Like actions, they may contain extra user-selected data.
        /// </summary>
        /// <param name="message"><see cref="ConnectorChangeEvent"/></param>
        public void OnConnecterChangeEvent(ConnectorChangeEvent message)
        {
            var dataArray = message.Data
                .Select(dataItem => $"\"{dataItem.Key}\":\"{dataItem.Value}\"")
                .ToArray();

            var dataString = string.Join(", ", dataArray);
            _logger?.LogInformation($"[OnConnecterChangeEvent] ConnectorId: '{message.ConnectorId}', Value: '{message.Value}', Data: '{dataString}'");
        }

        /// <summary>
        /// This event is generated when a TP user creates or modifies a slider which uses one of this plugin's Connectors.
        /// See the TP API documentation for usage details.
        /// </summary>
        /// <param name="message"><see cref="ShortConnectorIdNotificationEvent"/></param>
        public void OnShortConnectorIdNotificationEvent(ShortConnectorIdNotificationEvent message)
        {
            _logger?.LogInformation($"[OnShortConnectorIdNotificationEvent] ConnectorId: '{message.ConnectorId}', ShortID: '{message.ShortId}'");
        }

        /// <summary>
        /// The event was unknown and not handled, ex. a new version of TP is out with new features.
        /// </summary>
        /// <param name="jsonMessage"></param>
        public void OnUnhandledEvent(string jsonMessage)
        {
            _logger?.LogWarning($"Unhandled message: {jsonMessage}");
        }

  }
}