ChannelConnectOptions Class

Options provided on a client connection to a channel.

Inheritance Hierarchy

SystemObject
Openfin.Desktop.MessagingChannelConnectOptions

Namespace: Openfin.Desktop.Messaging
Assembly: OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.5.1

Syntax

public class ChannelConnectOptions

The ChannelConnectOptions type exposes the following members.

Constructors

	Name	Description
	ChannelConnectOptions	Constructs an instance configuring a new underlying JObject with the passed values.

Properties

	Name	Description
	ChannelName	Name of the target channel.
	Payload	Payload to pass to ChannelProvider.ClientConnected action.
	Wait	If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)