Click or drag to resize

ChannelBase Class

The base class for context channels.
Inheritance Hierarchy

Namespace:  OpenFin.FDC3.Channels
Assembly:  OpenFin.FDC3 (in OpenFin.FDC3.dll) Version: 0.2.1-alpha5
Syntax
public abstract class ChannelBase

The ChannelBase type exposes the following members.

Constructors
  NameDescription
Protected methodChannelBase
Initializes a new instance of the ChannelBase class
Top
Properties
  NameDescription
Public propertyChannelId
Top
Methods
  NameDescription
Public methodAddContextListenerAsync
Adds the event that is fired when a window broadcasts on this channel
Public methodAddEventListenerAsync
Public methodBroadcastAsync
Broadcasts the given context on this channel. Note that this function ca be used without first joining the channel, allowing applciations to broadcast on channels they are not members. This broadcast will be receied by all windows that are members of this channel, except for the window that makes the broadcast.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetCurrentContextAsync
Returns the last context that was broadcast on this channel. All channels initially have no context, until a window is added to the channel and then broadcasts. The context of a channel will be captured regardless of how it's set on the channel.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetMembersAsync
Returns a collection of all windows connected to this channel.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodJoinAsync
Adds the provided window to this channel. If this channel has a current context, the context will be passed to the window through its context listener upon joining this channel.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveContextListener
Removes the event fired when a window
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnsubscribeEventListenerAsync
Top
Fields
  NameDescription
Public fieldChannelType
Top
See Also