built-on-openfin / csharp-starter

This starter is focused on giving examples related to our C# adapter.

csharp-starter

This starter is focused on giving examples related to our C# adapter.

The examples are broken out by the two versions of the adapter that we support :

how-to.v1

This location contains the code that is supported by the version 1 of the dot net adapter (OpenfinDesktop 17.4.0). It supports a minimum of .Net framework 4.5.2 and .Net Core 3.1.

• Documentation	Description
  How To Create A Snapshot Client	This example shows you how you can ask a platform for a snapshot to save as part of your native application state (where the platform is a child view of your native app)
  How To Integrate with Workspace	This gives an example of how a Native Apps can integrate with a workspace platform (e.g. provide snapshot data from a native app to a platform, provide search results or call actions against a platform).
  How To Use Notifications	This gives an example of how Native Apps can create and use Notifications with a workspace platform
  Automation Testing	An example of how an embedded web view can be tested using the OpenFin Automation testing packages.
  Use A Notification Proxy	An example that shows how a native app can connect to a platform app via channels and send notification requests to it. This platform app is then responsible for creating the notifications. The advantage of this is faster development, less code upkeep on the part of the native app developers, as all updates to notifications can be implemented in the platform app itself. Furthermore, the platform app can service the needs of multiple native apps.
  Interop-Example	This is an example of a Windows Form Application that can: Connect to a broker (an application setup as an Interop Broker e.g. OpenFin Workspace https://github.com/built-on-openfin/workspace-starter/tree/main/how-to/workspace-platform-starter) Create a broker (which others can connect to) Fetch the list of contextual groups/channels from the current broker Listen for contextual changes Join a contextual group Leave the current contextual group Update the current context against the currently joined contextual group Creating and receiving an instrument context Fire an intent using the Contact Context

Other Resources

• How to use the Embedded WebView

how-to.v2

This location contains the code that is supported by the version 2 of the dot net adapter (Openfin.Net.Adapter 29.2.0). It supports .Net framework 6.0 and .Net 7.0.

Documentation	Description
Channels	This example shows you how you perform simple inter-process communication via the Channel API
Console App	This application demonstrates a simple way to connect to the OpenFin runtime environment.
IAB	This is a simple example that shows how to use the IAB api to send messages between applications.
Interop	This is a simple example that shows how to use the InterOp API to fire intents that will be picked up and processed by the OpenFin Workspace InterOp Broker.
Simple Connect	A simple example showing how to connect to the OpenFin runtime.
Snapshot Source	This example demonstrates creating a snapshot source client in your platform and calling it from a C# application.
Use Notifications Proxy	An example that shows how a native app can connect to a platform app via channels and send notification requests to it. This platform app is then responsible for creating the notifications. The advantage of this is faster development, less code upkeep on the part of the native app developers, as all updates to notifications can be implemented in the platform app itself. Furthermore, the platform app can service the needs of multiple native apps.
Unit Testing	An example showing how to create unit tests for OpenFin Channel API and InterOp.
Use a SideCar App - Basic	An example showing how to create a C# sidecar app to be used by a web OpenFin platform.

server

Asp.Net-Core-MVC-Starter

This location contains the code that shows how to use the OpenFin APIs from within an asp.net core mvc application. Note: Neither of these samples use the dotNet adapter that is used by the samples above.

Documentation	Description
OpenFin-Test-MVC-ClientSide	This example shows you how to use the OpenFin api from within the cshtml view file. It does not make use of any server side functionality. The sample demonstrates the sendContext (fire a context), addContextListener (listen for / receive context broadcasts) and fireIntent (initiate an intent) apis.
OpenFin-Test-MVC-ServerSide	This example shows you how to use the OpenFin api using server side processing of information received from the client side cshtml view. within the cshtml view file. The sample demonstrates the sendContext (fire a context) and addContextListener (listen for / receive context broadcasts) apis.

Documentation

• .NET Adapter
• .NET API Docs
• .NET Notification API Docs