/ fm / liveswitch / DataChannelCollection

Class: DataChannelCollection

fm.liveswitch.DataChannelCollection

A collection of data channels.

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new DataChannelCollection(): DataChannelCollection

Returns: DataChannelCollection

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelCollection.ts:12

Methods

add

▸ add(value: DataChannel): boolean

Adds a value.

Parameters:

Name Type Description
value DataChannel The value.

Returns: boolean

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:44

addMany

▸ addMany(values: DataChannel[]): void

Adds some values.

Parameters:

Name Type Description
values DataChannel[] The values.

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:69

addSuccess

▸ ProtectedaddSuccess(value: DataChannel): void

Invoked when an element is added to the collection.

Parameters:

Name Type Description
value DataChannel The value.

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:95

addSuccessNoLock

▸ ProtectedaddSuccessNoLock(value: DataChannel): void

Invoked after an element is added to the collection.

Parameters:

Name Type Description
value DataChannel The value.

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:107

any

▸ any(): boolean

Determined whether the collection contains at least one value.

Returns: boolean

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:118

▸ any(predicate: IFunction1<DataChannel, boolean>): boolean

Determined whether the collection contains at least one value that matches the specified predicate.

Parameters:

Name Type Description
predicate IFunction1<DataChannel, boolean> The predicate.

Returns: boolean

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:126

arrayFromList

▸ ProtectedarrayFromList(list: DataChannel[]): DataChannel[]

Creates an array from a list.

Parameters:

Name Type Description
list DataChannel[] The list.

Returns: DataChannel[]

Overrides: Collection

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelCollection.ts:30

contains

▸ contains(value: DataChannel): boolean

Determines whether the collection contains a value.

Parameters:

Name Type Description
value DataChannel The value.

Returns: boolean

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:155

createCollection

▸ ProtectedcreateCollection(): DataChannelCollection

Creates a collection.

Returns: DataChannelCollection

Overrides: Collection

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelCollection.ts:42

first

▸ first(): DataChannel

Gets the first value. Throws an exception if there are no values in the collection.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:178

▸ first(predicate: IFunction1<DataChannel, boolean>): DataChannel

Gets the first value that matches the specified predicate. Throws an exception if there are no such values in the collection.

Parameters:

Name Type Description
predicate IFunction1<DataChannel, boolean> The predicate.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:188

firstOrDefault

▸ firstOrDefault(): DataChannel

Gets the first value. Returns a default value if there are no values in the collection.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:214

▸ firstOrDefault(predicate: IFunction1<DataChannel, boolean>): DataChannel

Gets the first value that matches the specified predicate. Returns a default value if there are no such values in the collection.

Parameters:

Name Type Description
predicate IFunction1<DataChannel, boolean> The predicate.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:224

forEach

▸ forEach(callback: IAction2<DataChannel, number>): void

Executes a callback function once per value.

Parameters:

Name Type Description
callback IAction2<DataChannel, number> The callback to execute.

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:247

getCount

▸ getCount(): number

Gets the count.

Returns: number

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:262

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Collection

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelCollection.ts:10

getValue

▸ getValue(): DataChannel

Gets the value.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:274

getValues

▸ getValues(): DataChannel[]

Gets the values.

Returns: DataChannel[]

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:289

last

▸ last(): DataChannel

Gets the last value. Throws an exception if there are no values in the collection.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:303

▸ last(predicate: IFunction1<DataChannel, boolean>): DataChannel

Gets the last value that matches the specified predicate. Throws an exception if there are no such values in the collection.

Parameters:

Name Type Description
predicate IFunction1<DataChannel, boolean> The predicate.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:313

lastOrDefault

▸ lastOrDefault(): DataChannel

Gets the last value. Returns a default value if there are no values in the collection.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:339

▸ lastOrDefault(predicate: IFunction1<DataChannel, boolean>): DataChannel

Gets the last value that matches the specified predicate. Returns a default value if there are no such values in the collection.

Parameters:

Name Type Description
predicate IFunction1<DataChannel, boolean> The predicate.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:349

remove

▸ remove(value: DataChannel): boolean

Removes a value.

Parameters:

Name Type Description
value DataChannel The value.

Returns: boolean

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:372

removeAll

▸ removeAll(): void

Removes all values.

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:395

removeFirst

▸ removeFirst(): DataChannel

Removes the first value.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:416

▸ removeFirst(condition: IFunction1<DataChannel, boolean>): DataChannel

Removes the first value that matches a given condition.

Parameters:

Name Type
condition IFunction1<DataChannel, boolean>

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:422

removeLast

▸ removeLast(): DataChannel

Removes the last value.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:449

▸ removeLast(condition: IFunction1<DataChannel, boolean>): DataChannel

Removes the last value that matches a given condition.

Parameters:

Name Type
condition IFunction1<DataChannel, boolean>

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:455

removeMany

▸ removeMany(values: DataChannel[]): void

Removes some values.

Parameters:

Name Type Description
values DataChannel[] The values.

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:483

removeSuccess

▸ ProtectedremoveSuccess(value: DataChannel): void

Invoked when an element is removed from the collection.

Parameters:

Name Type Description
value DataChannel The value.

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:508

removeSuccessNoLock

▸ ProtectedremoveSuccessNoLock(value: DataChannel): void

Invoked after an element is removed from the collection.

Parameters:

Name Type Description
value DataChannel The value.

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:520

replace

▸ replace(values: DataChannel[]): void

Replaces the collection with a new set of values.

Parameters:

Name Type Description
values DataChannel[] The values.

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:532

setValue

▸ setValue(value: DataChannel): void

Sets the value.

Parameters:

Name Type
value DataChannel

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:548

setValues

▸ setValues(value: DataChannel[]): void

Sets the values.

Parameters:

Name Type
value DataChannel[]

Returns: void

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:564

single

▸ single(): DataChannel

Gets the only value. Throws an exception if there are no values or more than one value in the collection.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:583

▸ single(predicate: IFunction1<DataChannel, boolean>): DataChannel

Gets the only value that matches the specified predicate. Throws an exception if there are no values or more than one value in the collection.

Parameters:

Name Type
predicate IFunction1<DataChannel, boolean>

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:593

singleOrDefault

▸ singleOrDefault(): DataChannel

Gets the only value. Returns a default value if there are no values or more than one value in the collection.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:620

▸ singleOrDefault(predicate: IFunction1<DataChannel, boolean>): DataChannel

Gets the only value that matches the specified predicate. Returns a default value if there are no values or more than one value in the collection.

Parameters:

Name Type
predicate IFunction1<DataChannel, boolean>

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:630

toArray

▸ toArray(): DataChannel[]

Clones the values into a new array.

Returns: DataChannel[]

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:658

valueAt

▸ valueAt(index: number): DataChannel

Gets the value at the specified index. Throws an exception if a value does not exist at that index.

Parameters:

Name Type Description
index number The index.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:673

valueAtOrDefault

▸ valueAtOrDefault(index: number): DataChannel

Gets the value at the specified index. Returns a default value if a value does not exist at that index.

Parameters:

Name Type Description
index number The index.

Returns: DataChannel

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:693

where

▸ where(predicate: IFunction2<DataChannel, number, boolean>): DataChannelCollection

Creates a new collection with values that match the specified predicate.

Parameters:

Name Type Description
predicate IFunction2<DataChannel, number, boolean> The predicate.

Returns: DataChannelCollection

Inherited from: Collection

Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:715