Interface IChannel
The base interface for both IChannelClient and IChannelProvider providing the common functionality between them
Namespace: OpenFin.Net.Adapter.Channels
Assembly: OpenFin.Net.Adapter.dll
Syntax
public interface IChannelProperties
ChannelID
Gets the channel identifier.
Declaration
string ChannelID { get; }Property Value
| Type | Description |
|---|---|
| System.String | The channel identifier. |
ChannelName
Gets the name of the channel.
Declaration
string ChannelName { get; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the channel. |
Methods
RegisterTopic(String, Action)
Registers a topic name and a handler for that doesn't accept any arguments
Declaration
void RegisterTopic(string topic, Action listener)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | topic | The topic. |
| Action | listener | The listener. |
RegisterTopic<T>(String, Action<T>)
Registers a topic name and a handler for that accepts a parameter object
Declaration
void RegisterTopic<T>(string topic, Action<T> listener)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | topic | The topic. |
| Action<T> | listener | The listener. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of the expected parameter |
RegisterTopic<TResult>(String, Func<TResult>)
Registers a topic name and a handler for that doesn't accept any arguments and returns a value of type
Declaration
void RegisterTopic<TResult>(string topic, Func<TResult> listener)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | topic | The topic. |
| Func<TResult> | listener | The listener. |
Type Parameters
| Name | Description |
|---|---|
| TResult | The type of the result. |
RegisterTopic<T, TResult>(String, Func<T, TResult>)
Registers a topic name and a handler for that accepts a parameter object and returns a value of type
Declaration
void RegisterTopic<T, TResult>(string topic, Func<T, TResult> listener)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | topic | The topic. |
| Func<T, TResult> | listener | The listener. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of the expected parameter |
| TResult | The type of the result. |
UnregisterTopic(String)
Removes a previously registered topic
Declaration
bool UnregisterTopic(string topic)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | topic | The topic. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Events
Closed
Occurrs when the channel has closed.
Declaration
event EventHandler ClosedEvent Type
| Type | Description |
|---|---|
| EventHandler |
Opened
Occurs when the channel has opened.
Declaration
event EventHandler OpenedEvent Type
| Type | Description |
|---|---|
| EventHandler |