Interface IIdDataShareAdapter
An interface to provide live IPC adapters that can invoke methods directly using custom IDs without the runtime overhead of IPC queries.
Remarks​
Implement only methods you actually need. This can then be used to create a wrapper encapsulating the actually available methods or properties, either by the provider library, or on the consumer side.
Assembly: Dalamud.dll​
public interface IIdDataShareAdapter : IDisposable
Properties​
Version​
Gets the version of this adapter.
Version? Version { get; }
IsDisposed​
Gets a value indicating whether the adapter has already been disposed.
bool IsDisposed { get; }
Methods​
Invoke(int)​
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke(int methodId)
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
Remarks​
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1>(int, T1)​
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1>(int methodId, T1 argument1) where T1 : allows ref struct
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
Type Parameters​
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |