IEDMS_NotificationService interface
No description yet.
public interface IEDMS_NotificationService
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Methods
| Method | Returns | Description |
|---|---|---|
| Connect | bool | |
| Disconnect | void | |
| GetActiveUsers | IStrings | |
| GetConnected | bool | |
| IsUserActive | bool | |
| SendMessage | bool | |
| SetEvents | void | |
| Subscribe | bool | |
| UnSubscribe | bool |
Connect
No description yet.
bool Connect(out string argErrorMsg);
| Parameter | Type | Passing |
|---|---|---|
argErrorMsg | string | out |
Returns: bool
Disconnect
No description yet.
void Disconnect();
Returns: nothing (void)
GetActiveUsers
No description yet.
IStrings GetActiveUsers();
Returns: IStrings
Extension method of IEDMS_NotificationServiceHelper (using DXP;).
GetConnected
No description yet.
bool GetConnected();
Returns: bool
IsUserActive
No description yet.
bool IsUserActive(string argUserGUID);
| Parameter | Type | Passing |
|---|---|---|
argUserGUID | string | value |
Returns: bool
SendMessage
No description yet.
bool SendMessage(string argChannelName, string argMessageData);
| Parameter | Type | Passing |
|---|---|---|
argChannelName | string | value |
argMessageData | string | value |
Returns: bool
SetEvents
No description yet.
void SetEvents(IEDMS_NotificationServiceEvents argEvents);
void SetEvents(object argEvents);
| Parameter | Type | Passing |
|---|---|---|
argEvents | IEDMS_NotificationServiceEvents | value |
Returns: nothing (void)
The first overload is an extension method of IEDMS_NotificationServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.
Subscribe
No description yet.
bool Subscribe(string argChannelName);
| Parameter | Type | Passing |
|---|---|---|
argChannelName | string | value |
Returns: bool
UnSubscribe
No description yet.
bool UnSubscribe(string argChannelName);
| Parameter | Type | Passing |
|---|---|---|
argChannelName | string | value |
Returns: bool