Search Results for

    / fm / liveswitch / ManagedConnectionCollection

    Class: ManagedConnectionCollection

    fm.liveswitch.ManagedConnectionCollection

    A collection of connections.

    Hierarchy

    • Collection<ManagedConnection, ManagedConnectionCollection>

      ↳ ManagedConnectionCollection

    Table of contents

    Constructors

    • constructor

    Methods

    • add
    • addMany
    • addSuccess
    • addSuccessNoLock
    • any
    • arrayFromList
    • contains
    • createCollection
    • first
    • firstOrDefault
    • forEach
    • getById
    • getByRemoteId
    • getCount
    • getTypeString
    • getValue
    • getValues
    • last
    • lastOrDefault
    • remove
    • removeAll
    • removeFirst
    • removeLast
    • removeMany
    • removeSuccess
    • removeSuccessNoLock
    • replace
    • setValue
    • setValues
    • single
    • singleOrDefault
    • toArray
    • tryGetById
    • tryGetByRemoteId
    • valueAt
    • valueAtOrDefault
    • where

    Constructors

    constructor

    + new ManagedConnectionCollection(): ManagedConnectionCollection

    Returns: ManagedConnectionCollection

    Inherited from: Collection

    Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnectionCollection.ts:18

    Methods

    add

    ▸ add(value: ManagedConnection): boolean

    Adds a value.

    Parameters:

    Name Type Description
    value ManagedConnection The value.

    Returns: boolean

    Inherited from: Collection

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


    addMany

    ▸ addMany(values: ManagedConnection[]): void

    Adds some values.

    Parameters:

    Name Type Description
    values ManagedConnection[] The values.

    Returns: void

    Inherited from: Collection

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


    addSuccess

    ▸ ProtectedaddSuccess(value: ManagedConnection): void

    Invoked when an element is added to the collection.

    Parameters:

    Name Type Description
    value ManagedConnection The value.

    Returns: void

    Overrides: Collection

    Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnectionCollection.ts:40


    addSuccessNoLock

    ▸ ProtectedaddSuccessNoLock(value: ManagedConnection): void

    Invoked after an element is added to the collection.

    Parameters:

    Name Type Description
    value ManagedConnection 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<ManagedConnection, boolean>): boolean

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

    Parameters:

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

    Returns: boolean

    Inherited from: Collection

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


    arrayFromList

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

    Creates an array from a list.

    Parameters:

    Name Type Description
    list ManagedConnection[] The list.

    Returns: ManagedConnection[]

    Overrides: Collection

    Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnectionCollection.ts:57


    contains

    ▸ contains(value: ManagedConnection): boolean

    Determines whether the collection contains a value.

    Parameters:

    Name Type Description
    value ManagedConnection The value.

    Returns: boolean

    Inherited from: Collection

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


    createCollection

    ▸ ProtectedcreateCollection(): ManagedConnectionCollection

    Creates a collection.

    Returns: ManagedConnectionCollection

    Overrides: Collection

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


    first

    ▸ first(): ManagedConnection

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

    Returns: ManagedConnection

    Inherited from: Collection

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

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

    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<ManagedConnection, boolean> The predicate.

    Returns: ManagedConnection

    Inherited from: Collection

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


    firstOrDefault

    ▸ firstOrDefault(): ManagedConnection

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

    Returns: ManagedConnection

    Inherited from: Collection

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

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

    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<ManagedConnection, boolean> The predicate.

    Returns: ManagedConnection

    Inherited from: Collection

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


    forEach

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

    Executes a callback function once per value.

    Parameters:

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

    Returns: void

    Inherited from: Collection

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


    getById

    ▸ getById(idValue: string): ManagedConnection

    Gets a connection by ID.

    Parameters:

    Name Type Description
    idValue string The identifier.

    Returns: ManagedConnection

    The connection, or null if the connection does not exist.

    Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnectionCollection.ts:83


    getByRemoteId

    ▸ getByRemoteId(idValue: string): ManagedConnection

    Gets a connection by remote ID.

    Parameters:

    Name Type Description
    idValue string The identifier.

    Returns: ManagedConnection

    The connection, or null if the connection does not exist.

    Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnectionCollection.ts:106


    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/ManagedConnectionCollection.ts:10


    getValue

    ▸ getValue(): ManagedConnection

    Gets the value.

    Returns: ManagedConnection

    Inherited from: Collection

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


    getValues

    ▸ getValues(): ManagedConnection[]

    Gets the values.

    Returns: ManagedConnection[]

    Inherited from: Collection

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


    last

    ▸ last(): ManagedConnection

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

    Returns: ManagedConnection

    Inherited from: Collection

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

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

    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<ManagedConnection, boolean> The predicate.

    Returns: ManagedConnection

    Inherited from: Collection

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


    lastOrDefault

    ▸ lastOrDefault(): ManagedConnection

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

    Returns: ManagedConnection

    Inherited from: Collection

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

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

    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<ManagedConnection, boolean> The predicate.

    Returns: ManagedConnection

    Inherited from: Collection

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


    remove

    ▸ remove(value: ManagedConnection): boolean

    Removes a value.

    Parameters:

    Name Type Description
    value ManagedConnection 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(): ManagedConnection

    Removes the first value.

    Returns: ManagedConnection

    Inherited from: Collection

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

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

    Removes the first value that matches a given condition.

    Parameters:

    Name Type
    condition IFunction1<ManagedConnection, boolean>

    Returns: ManagedConnection

    Inherited from: Collection

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


    removeLast

    ▸ removeLast(): ManagedConnection

    Removes the last value.

    Returns: ManagedConnection

    Inherited from: Collection

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

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

    Removes the last value that matches a given condition.

    Parameters:

    Name Type
    condition IFunction1<ManagedConnection, boolean>

    Returns: ManagedConnection

    Inherited from: Collection

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


    removeMany

    ▸ removeMany(values: ManagedConnection[]): void

    Removes some values.

    Parameters:

    Name Type Description
    values ManagedConnection[] The values.

    Returns: void

    Inherited from: Collection

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


    removeSuccess

    ▸ ProtectedremoveSuccess(value: ManagedConnection): void

    Invoked when an element is removed from the collection.

    Parameters:

    Name Type Description
    value ManagedConnection The value.

    Returns: void

    Overrides: Collection

    Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnectionCollection.ts:128


    removeSuccessNoLock

    ▸ ProtectedremoveSuccessNoLock(value: ManagedConnection): void

    Invoked after an element is removed from the collection.

    Parameters:

    Name Type Description
    value ManagedConnection The value.

    Returns: void

    Inherited from: Collection

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


    replace

    ▸ replace(values: ManagedConnection[]): void

    Replaces the collection with a new set of values.

    Parameters:

    Name Type Description
    values ManagedConnection[] The values.

    Returns: void

    Inherited from: Collection

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


    setValue

    ▸ setValue(value: ManagedConnection): void

    Sets the value.

    Parameters:

    Name Type
    value ManagedConnection

    Returns: void

    Inherited from: Collection

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


    setValues

    ▸ setValues(value: ManagedConnection[]): void

    Sets the values.

    Parameters:

    Name Type
    value ManagedConnection[]

    Returns: void

    Inherited from: Collection

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


    single

    ▸ single(): ManagedConnection

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

    Returns: ManagedConnection

    Inherited from: Collection

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

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

    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<ManagedConnection, boolean>

    Returns: ManagedConnection

    Inherited from: Collection

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


    singleOrDefault

    ▸ singleOrDefault(): ManagedConnection

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

    Returns: ManagedConnection

    Inherited from: Collection

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

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

    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<ManagedConnection, boolean>

    Returns: ManagedConnection

    Inherited from: Collection

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


    toArray

    ▸ toArray(): ManagedConnection[]

    Clones the values into a new array.

    Returns: ManagedConnection[]

    Inherited from: Collection

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


    tryGetById

    ▸ tryGetById(idValue: string, connection: Holder<ManagedConnection>): boolean

    Tries to get a connection by ID.

    Parameters:

    Name Type Description
    idValue string The identifier.
    connection Holder<ManagedConnection> The connection.

    Returns: boolean

    The connection, or null if the connection does not exist.

    Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnectionCollection.ts:147


    tryGetByRemoteId

    ▸ tryGetByRemoteId(idValue: string, connection: Holder<ManagedConnection>): boolean

    Tries to get a connection by remote ID.

    Parameters:

    Name Type Description
    idValue string The identifier.
    connection Holder<ManagedConnection> The connection.

    Returns: boolean

    The connection, or null if the connection does not exist.

    Defined in: Generated/TypeScript/fm.liveswitch/ManagedConnectionCollection.ts:167


    valueAt

    ▸ valueAt(index: number): ManagedConnection

    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: ManagedConnection

    Inherited from: Collection

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


    valueAtOrDefault

    ▸ valueAtOrDefault(index: number): ManagedConnection

    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: ManagedConnection

    Inherited from: Collection

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


    where

    ▸ where(predicate: IFunction2<ManagedConnection, number, boolean>): ManagedConnectionCollection

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

    Parameters:

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

    Returns: ManagedConnectionCollection

    Inherited from: Collection

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

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.14.6