Class NodeManager
Предоставляет интерфейс для работы с объектами учета.
public class NodeManager : ServerObject, INodeManager
- Inheritance
-
NodeManager
- Implements
- Inherited Members
- Extension Methods
Properties
IsDeleteAllowed
Получает значение, определяющее, разрешено ли удаление объекта учета текущему пользователю.
public bool IsDeleteAllowed { get; }
Property Value
IsEditAllowed
Получает значение, определяющее, разрешено ли редактирование объекта учета текущему пользователю.
public bool IsEditAllowed { get; }
Property Value
Methods
GetById(int)
Получает объект учета по идентификатору.
public Node GetById(int id)
Parameters
idintУникальный идентификатор объекта учета.
Returns
- Node
Возвращает экземпляр Node или null, если объекта учета с таким идентификатором не существует или он недоступен для данной учетной записи.
GetById(int, NodeInfoFlags)
Получает объект учета и дополнительную информацию по идентификатору.
public Node GetById(int id, NodeInfoFlags flags)
Parameters
idintУникальный идентификатор объекта учета.
flagsNodeInfoFlagsФлаги, определяющие, какая дополнительная информация должна быть получена.
Returns
- Node
Возвращает экземпляр Node или null, если объекта учета с таким идентификатором не существует или он недоступен для данной учетной записи.
GetByIdAsync(int)
Асинхронно получает объект учёта по его идентификатору.
public Task<Node> GetByIdAsync(int id)
Parameters
idintИдентификатор объекта учёта.
Returns
GetByIdAsync(int, NodeInfoFlags)
Асинхронно получает объект учёта и дополнительные свойства по его идентификатору.
public Task<Node> GetByIdAsync(int id, NodeInfoFlags flags)
Parameters
idintИдентификатор объекта учёта.
flagsNodeInfoFlagsФлаги, определяющие, какая дополнительная информация должна быть получена.
Returns
GetByNumber(int, NodeInfoFlags)
Получает объект учёта и дополнительные свойства по его номеру.
public Node GetByNumber(int number, NodeInfoFlags flags)
Parameters
numberintНомер объекта учета.
flagsNodeInfoFlagsФлаги, определяющие, какая дополнительная информация должна быть получена.
Returns
GetByNumberAsync(int)
Асинхронно получает объект учёта по его номеру.
public Task<Node> GetByNumberAsync(int number)
Parameters
numberintНомер объекта учета.
Returns
- Task<Node>
Задание, которое после завершения вернёт экземпляр Node или null, если объекта учета с таким номером не существует или он недоступен для данной учетной записи.
GetByNumberAsync(int, NodeInfoFlags)
Асинхронно получает объект учёта и дополнительные свойства по его номеру.
public Task<Node> GetByNumberAsync(int number, NodeInfoFlags flags)
Parameters
numberintНомер объекта учета.
flagsNodeInfoFlagsФлаги, определяющие, какая дополнительная информация должна быть получена.
Returns
- Task<Node>
Задание, которое после завершения вернёт экземпляр Node или null, если объекта учета с таким номером не существует или он недоступен для данной учетной записи.
GetList()
Получает список объектов учета.
public Node[] GetList()
Returns
GetList(NodeInfoFlags)
Получает список объектов учета.
public Node[] GetList(NodeInfoFlags flags)
Parameters
flagsNodeInfoFlagsФлаги, определяющие, какую дополнительную информацию нужно вернуть.
Returns
GetList(int)
Получает список объектов учета в указанной группе объектов учета.
public Node[] GetList(int nodeGroupId)
Parameters
nodeGroupIdintИдентификатор группы объектов.
Returns
GetList(int?, NodeInfoFlags)
Получает список объектов учета в указанной группе объектов учета.
public Node[] GetList(int? nodeGroupId, NodeInfoFlags flags)
Parameters
nodeGroupIdint?Идентификатор группы объектов.
flagsNodeInfoFlagsФлаги, определяющие, какую дополнительную информацию нужно вернуть.
Returns
GetListAsync()
Асинхронно получает список объектов учёта.
public Task<Node[]> GetListAsync()
Returns
GetListAsync(NodeInfoFlags)
Асинхронно получает список объектов учёта и дополнительные данные.
public Task<Node[]> GetListAsync(NodeInfoFlags flags)
Parameters
flagsNodeInfoFlags
Returns
GetListAsync(IEnumerable<int>)
Асинхронно получает список объектов учёта с указанными идентификаторами.
public Task<Node[]> GetListAsync(IEnumerable<int> idList)
Parameters
idListIEnumerable<int>Список идентификаторов объектов, которые нужно получить с сервера.
Returns
GetListAsync(IEnumerable<int>, NodeInfoFlags)
Асинхронно получает список объектов учёта с указанными идентификаторами.
public Task<Node[]> GetListAsync(IEnumerable<int> idList, NodeInfoFlags flags)
Parameters
idListIEnumerable<int>Список идентификаторов объектов, которые нужно получить с сервера.
flagsNodeInfoFlagsФлаги, определяющие какую информацию нужно вернуть.
Returns
GetListAsync(int)
Асинхронно получает список объектов учёта, входящих в указанную группу объектов.
public Task<Node[]> GetListAsync(int nodeGroupId)
Parameters
nodeGroupIdint
Returns
GetListAsync(int?, NodeInfoFlags)
Получает список объектов учета.
public Task<Node[]> GetListAsync(int? nodeGroupId, NodeInfoFlags flags)
Parameters
nodeGroupIdint?Идентификатор группы объектов.
flagsNodeInfoFlagsФлаги, определяющие, какую дополнительную информацию нужно вернуть.
Returns
NewNode(string)
Создает новый объект учета.
public Node NewNode(string title)
Parameters
titlestringНаименование объекта учета.
Returns
Remarks
Уникальным является сочетание наименования объекта и его адреса, поэтому для создания рекомендуется использовать метод, который позволяет задать сразу оба параметра. NewNode(string, string).
NewNode(string, string)
Создает новый объект учета.
public Node NewNode(string title, string address)
Parameters
Returns
NewPowerSource(string)
Создаёт новый источник.
public PowerSource NewPowerSource(string title)
Parameters
titlestringНаименование источника.
Returns
- PowerSource
Новый источник.
NewPowerSource(string, string)
Создаёт новый источник.
public PowerSource NewPowerSource(string title, string address)
Parameters
Returns
- PowerSource
Новый источник.
Events
NodeChanged
Вызывается когда от сервера приходит событие об изменении объекта учёта.
public event EventHandler<NodeChangedEventArgs> NodeChanged