/ fm / liveswitch / IceServerCollection
Class: IceServerCollection
fm.liveswitch.IceServerCollection
An ICE server collection.
Hierarchy
Collection<IceServer, IceServerCollection>
↳ IceServerCollection
Table of contents
Constructors
Methods
- add
- addMany
- addSuccess
- addSuccessNoLock
- any
- arrayFromList
- contains
- createCollection
- first
- firstOrDefault
- forEach
- getCount
- getTypeString
- getValue
- getValues
- last
- lastOrDefault
- remove
- removeAll
- removeFirst
- removeLast
- removeMany
- removeSuccess
- removeSuccessNoLock
- replace
- setValue
- setValues
- single
- singleOrDefault
- toArray
- valueAt
- valueAtOrDefault
- where
Constructors
constructor
+ new IceServerCollection(): IceServerCollection
Returns: IceServerCollection
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/IceServerCollection.ts:12
Methods
add
▸ add(value
: IceServer): boolean
Adds a value.
Parameters:
Name | Type | Description |
---|---|---|
value |
IceServer | The value. |
Returns: boolean
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:44
addMany
▸ addMany(values
: IceServer[]): void
Adds some values.
Parameters:
Name | Type | Description |
---|---|---|
values |
IceServer[] | The values. |
Returns: void
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:69
addSuccess
▸ Protected
addSuccess(value
: IceServer): void
Invoked when an element is added to the collection.
Parameters:
Name | Type | Description |
---|---|---|
value |
IceServer | The value. |
Returns: void
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:95
addSuccessNoLock
▸ Protected
addSuccessNoLock(value
: IceServer): void
Invoked after an element is added to the collection.
Parameters:
Name | Type | Description |
---|---|---|
value |
IceServer | 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<IceServer, boolean>): boolean
Determined whether the collection contains at least one value that matches the specified predicate.
Parameters:
Name | Type | Description |
---|---|---|
predicate |
IFunction1<IceServer, boolean> | The predicate. |
Returns: boolean
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:126
arrayFromList
▸ Protected
arrayFromList(list
: IceServer[]): IceServer[]
Creates an array from a list.
Parameters:
Name | Type | Description |
---|---|---|
list |
IceServer[] | The list. |
Returns: IceServer[]
Overrides: Collection
Defined in: Generated/TypeScript/fm.liveswitch/IceServerCollection.ts:30
contains
▸ contains(value
: IceServer): boolean
Determines whether the collection contains a value.
Parameters:
Name | Type | Description |
---|---|---|
value |
IceServer | The value. |
Returns: boolean
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:155
createCollection
▸ Protected
createCollection(): IceServerCollection
Creates a collection.
Returns: IceServerCollection
Overrides: Collection
Defined in: Generated/TypeScript/fm.liveswitch/IceServerCollection.ts:42
first
▸ first(): IceServer
Gets the first value. Throws an exception if there are no values in the collection.
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:178
▸ first(predicate
: IFunction1<IceServer, boolean>): IceServer
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<IceServer, boolean> | The predicate. |
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:188
firstOrDefault
▸ firstOrDefault(): IceServer
Gets the first value. Returns a default value if there are no values in the collection.
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:214
▸ firstOrDefault(predicate
: IFunction1<IceServer, boolean>): IceServer
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<IceServer, boolean> | The predicate. |
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:224
forEach
▸ forEach(callback
: IAction2<IceServer, number>): void
Executes a callback function once per value.
Parameters:
Name | Type | Description |
---|---|---|
callback |
IAction2<IceServer, 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/IceServerCollection.ts:10
getValue
▸ getValue(): IceServer
Gets the value.
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:274
getValues
▸ getValues(): IceServer[]
Gets the values.
Returns: IceServer[]
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:289
last
▸ last(): IceServer
Gets the last value. Throws an exception if there are no values in the collection.
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:303
▸ last(predicate
: IFunction1<IceServer, boolean>): IceServer
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<IceServer, boolean> | The predicate. |
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:313
lastOrDefault
▸ lastOrDefault(): IceServer
Gets the last value. Returns a default value if there are no values in the collection.
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:339
▸ lastOrDefault(predicate
: IFunction1<IceServer, boolean>): IceServer
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<IceServer, boolean> | The predicate. |
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:349
remove
▸ remove(value
: IceServer): boolean
Removes a value.
Parameters:
Name | Type | Description |
---|---|---|
value |
IceServer | 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(): IceServer
Removes the first value.
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:416
▸ removeFirst(condition
: IFunction1<IceServer, boolean>): IceServer
Removes the first value that matches a given condition.
Parameters:
Name | Type |
---|---|
condition |
IFunction1<IceServer, boolean> |
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:422
removeLast
▸ removeLast(): IceServer
Removes the last value.
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:449
▸ removeLast(condition
: IFunction1<IceServer, boolean>): IceServer
Removes the last value that matches a given condition.
Parameters:
Name | Type |
---|---|
condition |
IFunction1<IceServer, boolean> |
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:455
removeMany
▸ removeMany(values
: IceServer[]): void
Removes some values.
Parameters:
Name | Type | Description |
---|---|---|
values |
IceServer[] | The values. |
Returns: void
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:483
removeSuccess
▸ Protected
removeSuccess(value
: IceServer): void
Invoked when an element is removed from the collection.
Parameters:
Name | Type | Description |
---|---|---|
value |
IceServer | The value. |
Returns: void
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:508
removeSuccessNoLock
▸ Protected
removeSuccessNoLock(value
: IceServer): void
Invoked after an element is removed from the collection.
Parameters:
Name | Type | Description |
---|---|---|
value |
IceServer | The value. |
Returns: void
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:520
replace
▸ replace(values
: IceServer[]): void
Replaces the collection with a new set of values.
Parameters:
Name | Type | Description |
---|---|---|
values |
IceServer[] | The values. |
Returns: void
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:532
setValue
▸ setValue(value
: IceServer): void
Sets the value.
Parameters:
Name | Type |
---|---|
value |
IceServer |
Returns: void
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:548
setValues
▸ setValues(value
: IceServer[]): void
Sets the values.
Parameters:
Name | Type |
---|---|
value |
IceServer[] |
Returns: void
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:564
single
▸ single(): IceServer
Gets the only value. Throws an exception if there are no values or more than one value in the collection.
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:583
▸ single(predicate
: IFunction1<IceServer, boolean>): IceServer
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<IceServer, boolean> |
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:593
singleOrDefault
▸ singleOrDefault(): IceServer
Gets the only value. Returns a default value if there are no values or more than one value in the collection.
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:620
▸ singleOrDefault(predicate
: IFunction1<IceServer, boolean>): IceServer
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<IceServer, boolean> |
Returns: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:630
toArray
▸ toArray(): IceServer[]
Clones the values into a new array.
Returns: IceServer[]
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:658
valueAt
▸ valueAt(index
: number): IceServer
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: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:673
valueAtOrDefault
▸ valueAtOrDefault(index
: number): IceServer
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: IceServer
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:693
where
▸ where(predicate
: IFunction2<IceServer, number, boolean>): IceServerCollection
Creates a new collection with values that match the specified predicate.
Parameters:
Name | Type | Description |
---|---|---|
predicate |
IFunction2<IceServer, number, boolean> | The predicate. |
Returns: IceServerCollection
Inherited from: Collection
Defined in: Generated/TypeScript/fm.liveswitch/Collection.ts:715