A read-only collection of interaction identifiers to ININ.Addins.IC.Interactions.IInteraction instances.
Members
size :Number
Returns the number of interactions stored in this collection.
Methods
forEach(callback[, thisVar])
Iterates through each ININ.Addins.IC.Interactions.IInteraction instance contained in this collection.
Parameters
| Name | Type | Description |
|---|---|---|
| callback | ININ.Addins.IC.Interactions.IReadOnlyInteractionCollection~forEachCallback |
The function to execute for each interaction. |
| thisVar | Any |
The value to assign to |
get(interactionId) :ININ.Addins.IC.Interactions.IInteraction
Retrieves the specified interaction based on its identifier.
Parameters
| Name | Type | Description |
|---|---|---|
| interactionId | String |
The identifier of the interaction to retrieve. |
Returns
The interaction if it is stored in this map, otherwise undefined.
has(interactionId) :Boolean
Determines whether an interaction represented by the specified interaction identifier is contained in this collection.
Parameters
| Name | Type | Description |
|---|---|---|
| interactionId | String |
The interaction identifier. |
Returns
true if there is an interaction is contained in this collection; otherwise false.
- Type
- Boolean
Type Definitions
forEachCallback(interaction, interactionId, collection)
This is the function to execute for each interaction.
Parameters
| Name | Type | Description |
|---|---|---|
| interaction | ININ.Addins.IC.Interactions.IInteraction |
The interaction. |
| interactionId | String |
The interaction identifier. |
| collection | ININ.Addins.IC.Interactions.IReadOnlyInteractionCollection |
The interaction collection. |