Class PropertyOwnerApiClient
Контроллер для работы с владельцами свойств.
public class PropertyOwnerApiClient : IDisposable
- Inheritance
-
PropertyOwnerApiClient
- Implements
- Inherited Members
Constructors
PropertyOwnerApiClient(HttpClient)
public PropertyOwnerApiClient(HttpClient httpClient)
Parameters
httpClientHttpClient
Methods
AddManyOwnConcepts(IAddManyToRequest, CancellationToken)
Добавляет собственные понятия объекту.
public Task AddManyOwnConcepts(IAddManyToRequest request, CancellationToken cancellationToken = default)
Parameters
requestIAddManyToRequestЗапрос добавления собственных понятий объекту.
cancellationTokenCancellationToken
Returns
AddManyOwnProperties(IAddManyToRequest, CancellationToken)
Добавляет собственные свойства объекту.
public Task AddManyOwnProperties(IAddManyToRequest request, CancellationToken cancellationToken = default)
Parameters
requestIAddManyToRequestЗапрос добавления собственных свойств объекту.
cancellationTokenCancellationToken
Returns
AddTablePropertyRow(IAddTablePropertyRowRequest, CancellationToken)
Добавляет новую строку в табличное свойство.
public Task AddTablePropertyRow(IAddTablePropertyRowRequest request, CancellationToken cancellationToken = default)
Parameters
requestIAddTablePropertyRowRequestЗапрос добавления строки в табличное свойство.
cancellationTokenCancellationToken
Returns
Dispose()
public void Dispose()
GetBinaryPropertyValue(IGetPropertyRequest, CancellationToken)
Возвращает имя временного файла в хранилище для скачивания значения бинарного свойства.
public Task<string?> GetBinaryPropertyValue(IGetPropertyRequest request, CancellationToken cancellationToken = default)
Parameters
requestIGetPropertyRequestЗапрос получения значения свойства.
cancellationTokenCancellationToken
Returns
GetByGroup(IGetPropertiesByGroupRequest, CancellationToken)
Постранично возвращает элементы группы.
public Task<IGetPropertiesByGroupResponse?> GetByGroup(IGetPropertiesByGroupRequest request, CancellationToken cancellationToken = default)
Parameters
requestIGetPropertiesByGroupRequestЗапрос страницы.
cancellationTokenCancellationToken
Returns
GetById(IGetByIdRequest, CancellationToken)
Возвращает владельца свойств.
public Task<IPropertyOwnerResponse?> GetById(IGetByIdRequest request, CancellationToken cancellationToken = default)
Parameters
requestIGetByIdRequestЗапрос поиска объекта по Guid.
cancellationTokenCancellationToken
Returns
GetByLocation(string, CancellationToken)
Возвращает свойства владельца свойств по строке расположения.
public Task<IPropertyOwnerResponse?> GetByLocation(string location, CancellationToken cancellationToken = default)
Parameters
locationstringСтрока расположения.
cancellationTokenCancellationToken
Returns
- Task<IPropertyOwnerResponse>
Возвращает контейнер владельцев свойств, содержащий данные только о запрашиваемом свойстве
GetByUid(IGetByUidRequest, CancellationToken)
Возвращает владельца свойств по его идентификатору.
public Task<IPropertyOwnerResponse?> GetByUid(IGetByUidRequest request, CancellationToken cancellationToken = default)
Parameters
requestIGetByUidRequestЗапрос поиска объекта по Guid.
cancellationTokenCancellationToken
Returns
GetLinkedPropertyPreview(IGetLinkedPropertyRequest, CancellationToken)
Возвращает значение связанного свойства для предпросмотра.
public Task<IPropertyValueContainer?> GetLinkedPropertyPreview(IGetLinkedPropertyRequest request, CancellationToken cancellationToken = default)
Parameters
requestIGetLinkedPropertyRequestЗапрос смены значений свойства.
cancellationTokenCancellationToken
Returns
GetProperties(IGetPropertiesRequest, CancellationToken)
Возвращает владельца свойств.
public Task<IPropertyOwnerResponse?> GetProperties(IGetPropertiesRequest request, CancellationToken cancellationToken = default)
Parameters
requestIGetPropertiesRequestПараметры запроса.
cancellationTokenCancellationToken
Returns
GetProperty(IGetPropertyRequest, CancellationToken)
Возвращает свойство владельца свойств.
public Task<IPropertyResponse?> GetProperty(IGetPropertyRequest request, CancellationToken cancellationToken = default)
Parameters
requestIGetPropertyRequestЗапрос свойства владельца свойств.
cancellationTokenCancellationToken
Returns
- Task<IPropertyResponse>
Возвращает контейнер владельцев свойств, содержащий данные только о запрашиваемом свойстве.
GetTileImage(IIdentifierRequest, CancellationToken)
Возвращает изображение предварительного просмотра для элемента структуры.
public Task<string?> GetTileImage(IIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
requestIIdentifierRequestИдентификатор элемента структуры.
cancellationTokenCancellationToken
Returns
Realizes(IRealizesRequest, CancellationToken)
Проверяет реализацию контрактов у владельца свойств.
public Task Realizes(IRealizesRequest request, CancellationToken cancellationToken = default)
Parameters
requestIRealizesRequestПараметры запроса.
cancellationTokenCancellationToken
Returns
ReevaluateElementFormulas(IIdentifierRequest, CancellationToken)
Перевычисляет все поля элемента по формулам и возвращает владельца свойств.
public Task<IPropertyOwnerResponse?> ReevaluateElementFormulas(IIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
requestIIdentifierRequestИдентификатор элемента.
cancellationTokenCancellationToken
Returns
ReevaluateGroupFormulas(IIdentifierRequest, CancellationToken)
Перевычисляет все поля по формулам в группе.
public Task ReevaluateGroupFormulas(IIdentifierRequest request, CancellationToken cancellationToken = default)
Parameters
requestIIdentifierRequestИдентификатор группы.
cancellationTokenCancellationToken
Returns
RemoveManyOwnConcepts(IRemoveManyOwnConceptsRequest, CancellationToken)
Удаляет собственные понятия объекта.
public Task RemoveManyOwnConcepts(IRemoveManyOwnConceptsRequest request, CancellationToken cancellationToken = default)
Parameters
requestIRemoveManyOwnConceptsRequestЗапрос удаления собственных понятий объекта.
cancellationTokenCancellationToken
Returns
RemoveManyOwnProperties(IRemoveManyOwnPropertiesRequest, CancellationToken)
Удаляет собственные свойства объекта.
public Task RemoveManyOwnProperties(IRemoveManyOwnPropertiesRequest request, CancellationToken cancellationToken = default)
Parameters
requestIRemoveManyOwnPropertiesRequestЗапрос удаления собственных свойств объекта.
cancellationTokenCancellationToken
Returns
RemoveTablePropertyRow(IRemoveTablePropertyRowRequest, CancellationToken)
Удаляет указанную строку из табличного свойства.
public Task RemoveTablePropertyRow(IRemoveTablePropertyRowRequest request, CancellationToken cancellationToken = default)
Parameters
requestIRemoveTablePropertyRowRequestЗапрос удаления строки из табличного свойства.
cancellationTokenCancellationToken
Returns
ReplaceTablePropertyRow(IReplaceTablePropertyRowRequest, CancellationToken)
Изменяет позицию строки в табличном свойстве.
public Task ReplaceTablePropertyRow(IReplaceTablePropertyRowRequest request, CancellationToken cancellationToken = default)
Parameters
requestIReplaceTablePropertyRowRequestЗапрос изменения позиции строки в табличном свойстве
cancellationTokenCancellationToken
Returns
SetExternalFormula(ISetExternalFormulaRequest, CancellationToken)
Вычисляет значение свойства по формуле, заданной для группы.
public Task<IPropertyResponse?> SetExternalFormula(ISetExternalFormulaRequest request, CancellationToken cancellationToken = default)
Parameters
requestISetExternalFormulaRequestЗапрос вычисления значения свойства.
cancellationTokenCancellationToken
Returns
SetFormulaPropertyValues(ISetFormulaPropertyValueRequest, CancellationToken)
Устанавливает формулы для вычисления свойств владельца свойств.
public Task SetFormulaPropertyValues(ISetFormulaPropertyValueRequest request, CancellationToken cancellationToken = default)
Parameters
requestISetFormulaPropertyValueRequestЗапрос смены значений свойств.
cancellationTokenCancellationToken
Returns
SetLinkedPropertyValues(ISetLinkedPropertyValuesRequest, CancellationToken)
Устанавливает значения связанных свойств владельца свойств.
public Task SetLinkedPropertyValues(ISetLinkedPropertyValuesRequest request, CancellationToken cancellationToken = default)
Parameters
requestISetLinkedPropertyValuesRequestЗапрос смены значений свойств.
cancellationTokenCancellationToken
Returns
SetPropertyValues(ISetPropertyValuesRequest, CancellationToken)
Устанавливает значения свойств владельца свойств.
public Task<ISetPropertyValuesResponse?> SetPropertyValues(ISetPropertyValuesRequest request, CancellationToken cancellationToken = default)
Parameters
requestISetPropertyValuesRequestЗапрос изменения значений свойств.
cancellationTokenCancellationToken
Returns
SetTablePropertyValues(ISetTablePropertyValuesRequest, CancellationToken)
Устанавливает значения свойств таблицы.
public Task SetTablePropertyValues(ISetTablePropertyValuesRequest request, CancellationToken cancellationToken = default)
Parameters
requestISetTablePropertyValuesRequestЗапрос изменения значений табличного свойства.
cancellationTokenCancellationToken
Returns
UploadBinaryPropertyValue(byte[], CancellationToken)
Загружает файл из массива байт в multipart/form-data.
public Task<string?> UploadBinaryPropertyValue(byte[] file, CancellationToken cancellationToken = default)
Parameters
filebyte[]cancellationTokenCancellationToken
Returns
UploadBinaryPropertyValue(Stream, CancellationToken)
Загружает файл во временное хранилище.
public Task<string?> UploadBinaryPropertyValue(Stream file, CancellationToken cancellationToken = default)
Parameters
fileStreamФайл.
cancellationTokenCancellationToken