Работа с данными платформы. API - История изменений

AZykov: /* Подписка на события класса */

2025-12-24T14:39:55Z

Подписка на события класса

← Предыдущая версия		Версия от 14:39, 24 декабря 2025
Строка 67:		Строка 67:

	Вариантом по-умолчанию можно считать IDataUpdateParams<IBaseEntity>, в таком случае в параметре невозможно будет получить значения свойств класса, вызвавшего событие. Будет доступен только его ID.		Вариантом по-умолчанию можно считать IDataUpdateParams<IBaseEntity>, в таком случае в параметре невозможно будет получить значения свойств класса, вызвавшего событие. Будет доступен только его ID.
			[[Файл:Настройка класса для получения коллекции oldData.png\|мини\|Настройка класса для получения коллекции oldData]]
	Однако, если использовать типизацию интерфейсом того класса, чьи изменения ожидаются, например - IDataUpdateParams<ITicket>, то через свойство '''entity''' моно получить доступ к свойствам экземпляра класса.		Однако, если использовать типизацию интерфейсом того класса, чьи изменения ожидаются, например - IDataUpdateParams<ITicket>, то через свойство '''entity''' моно получить доступ к свойствам экземпляра класса.

	Также, в данном параметре передаются две коллекции - oldData и newData. В этих коллекциях можно получить изначальные и новые значения свойств объекта, при обработке событий изменения объекта.		Также, в данном параметре передаются две коллекции - oldData и newData. В этих коллекциях можно получить изначальные и новые значения свойств объекта, при обработке событий изменения объекта.

			Наличие коллекции oldData определяется свойством класса "subscribeForOldData".

Elena в 12:54, 17 марта 2025

2025-03-17T12:54:30Z

← Предыдущая версия		Версия от 12:54, 17 марта 2025
Строка 285:		Строка 285:

	Предыдущая статья курса: [[Получение информации о пользователе]]		Предыдущая статья курса: [[Получение информации о пользователе]]
	[[Категория:Курс "Разработка приложений"]]		[[Категория:Курс Разработка приложений]]

AZykov: /* Подписка на события класса */

2025-03-13T13:20:50Z

Подписка на события класса

← Предыдущая версия		Версия от 13:20, 13 марта 2025
Строка 61:		Строка 61:
	* onAfterDelete - событие вызывается после удаления объекта класса		* onAfterDelete - событие вызывается после удаления объекта класса
	* onAfterModify - событие вызвается после модификации объекта класса		* onAfterModify - событие вызвается после модификации объекта класса
	* onAfterReload - ~~TODO/////~~		* onAfterReload - событие после перезагрузки класса из хранилища. Используется при потере актуальности кеша
	* onAfterUpdate - ~~TODO///~~//		* onAfterUpdate - универсальное событие после delete/modify/insert

	В параметр функции, вызываемой каждым событием передается дженерик-параметр IDataUpdateParams, который может быть типизирован каким-либо интерфейсом.		В параметр функции, вызываемой каждым событием передается дженерик-параметр IDataUpdateParams, который может быть типизирован каким-либо интерфейсом.

AZykov: /* Вызов сервисов платформы и работа с внутренним API */

2025-03-10T16:07:27Z

Вызов сервисов платформы и работа с внутренним API

← Предыдущая версия		Версия от 16:07, 10 марта 2025
Строка 273:		Строка 273:
	= Вызов сервисов платформы и работа с внутренним API =		= Вызов сервисов платформы и работа с внутренним API =

	Работу с сервисами платформы можно условно разделить		Работу с сервисами платформы можно условно разделить на две категории:

			* Работа с сервисами продуктового слоя - вызов сервисов, реализованных в сторонних пакетах
			* Работа с платформенными сервисами - вызов базовых сервисов платформы

			Полную документацию по работе с платформенными сервисами можно найти на [https://vendor.era-platform.ru/docs/era/latest/api/index.html портале Vendor].

			Работа с сервисами продуктового слоя сводится к изучению их исходного кода (он выгружается в разделе Services). Техническая же сторона работы с вызовами описана в статье [[Разработка сервисов]].

	Следующая статья курса: [[Работа с внешними системами. Возможности интеграции]]		Следующая статья курса: [[Работа с внешними системами. Возможности интеграции]]

	Предыдущая статья курса: [[Получение информации о пользователе]]		Предыдущая статья курса: [[Получение информации о пользователе]]
	[[Категория:Курс "Разработка приложений"]]		[[Категория:Курс "Разработка приложений"]]

AZykov: /* Вызов сервисов платформы и работа с внутренним API */

2025-03-10T15:56:21Z

Вызов сервисов платформы и работа с внутренним API

← Предыдущая версия		Версия от 15:56, 10 марта 2025
Строка 273:		Строка 273:
	= Вызов сервисов платформы и работа с внутренним API =		= Вызов сервисов платформы и работа с внутренним API =

			Работу с сервисами платформы можно условно разделить
	Следующая статья курса: [[Работа с внешними системами. Возможности интеграции]]		Следующая статья курса: [[Работа с внешними системами. Возможности интеграции]]

	Предыдущая статья курса: [[Получение информации о пользователе]]		Предыдущая статья курса: [[Получение информации о пользователе]]
	[[Категория:Курс "Разработка приложений"]]		[[Категория:Курс "Разработка приложений"]]

AZykov: /* Удаление объекта класса */

2025-03-10T15:31:48Z

Удаление объекта класса

← Предыдущая версия		Версия от 15:31, 10 марта 2025
Строка 270:		Строка 270:
	export default Server2Service;		export default Server2Service;
	</syntaxhighlight>		</syntaxhighlight>

			= Вызов сервисов платформы и работа с внутренним API =

AZykov: /* Модификация объекта класса */

2025-03-10T15:30:15Z

Модификация объекта класса

← Предыдущая версия		Версия от 15:30, 10 марта 2025
Строка 227:		Строка 227:

	= Удаление объекта класса =		= Удаление объекта класса =

			Для удаления объекта класса, его экземпляр необходимо также получить любым из способов.

			Для удаления объекта класса используется асинхронный метод delete.

			Использование метода может вызвать исключение, например если какие-либо проверки прерывают операцию удаления объекта.<syntaxhighlight lang="typescript">
			import { GlobalUtils, Converter } from "./../../utils";
			import { Service } from "./../../platform/core";
			import { ITicket, ITickets } from "../model";
			import { Tickets } from "../classes";
			import { IBaseEntity, IDataUpdateParams } from "../../base/model";

			class Server2Service extends Service {
			private _tickets: ITickets; //свойство класса, через которое мы будем доступаться к коллекции Tickets

			constructor() {
			super("creomate_tutorial.Server2Service");

			// onCreateCode
			this._tickets = new Tickets(this.context); //инициализируем коллекцию Tickets

			this.load();
			}
			async deleteTicketById(id: string){
			try{
			const ticket = await this._tickets.getByIDStrong(id);
			try{
			await ticket.delete();
			}catch(e){

			this.log.exception("deleteTicketById", e);

			}
			}catch(e){

			this.log.exception("deleteTicketById: get ticket by ID", e);

			}

			}
			}
			export default Server2Service;
			</syntaxhighlight>

AZykov: /* Создание объекта класса */

2025-03-10T15:26:27Z

Создание объекта класса

@@ Строка 146: / Строка 146: @@
 = Создание объекта класса =
 = Модификация объекта класса =
 = Удаление объекта класса =

AZykov: /* Получение объекта класса по ID */

2025-03-10T15:05:06Z

Получение объекта класса по ID

@@ Строка 74: / Строка 74: @@
 = Получение объекта класса по ID =
 = Поиск объекта класса =
 = Создание объекта класса =

AZykov: /* Подписка на события класса */

2025-03-10T14:50:37Z

Подписка на события класса

← Предыдущая версия		Версия от 14:50, 10 марта 2025
Строка 22:		Строка 22:

	= Подписка на события класса =		= Подписка на события класса =


			Для доступа к событиям классов используется коллекция объектов этих классов. Её название аналогично названию classMultiName.

			В примере кода ниже, создается приватное свойство класса для хранения коллекции, затем в конструкторе эта коллекция инициализируется, и далее происходит бинд события на метод внутри класса сервиса.<syntaxhighlight lang="typescript">
			import { GlobalUtils, Converter } from "./../../utils";
			import { Service } from "./../../platform/core";
			import { ITicket, ITickets } from "../model";
			import { Tickets } from "../classes";
			import { IBaseEntity, IDataUpdateParams } from "../../base/model";

			class Server2Service extends Service {
			private _tickets: ITickets; //свойство класса, через которое мы будем доступаться к коллекции Tickets

			constructor() {
			super("creomate_tutorial.Server2Service");

			// onCreateCode
			this._tickets = new Tickets(this.context); //инициализируем коллекцию Tickets
			this._tickets.onAfterInsert(this.onTicketAfterInsert.bind(this)); //привязываем метод onTicketAfterInsert к событию onAfterInsert коллекции Tickets
			this.load();
			}
			onTicketAfterInsert(params_: IDataUpdateParams<ITicket>){
			this.log.info(params_.updateKind); //В этом свойстве хранится тип опецации (удаление, изменение, добавление)
			this.log.info(params_.id); //В этом свойстве хранится ID объекта, над которым была совершена операция
			this.log.info(params_.entity?.subject); //В свойстве entity хранятся данные объекта, в данном случае получаем поле subject из объекта класса


			}
			}
			export default Server2Service;
			</syntaxhighlight>Данный пример кода будет выводить в лог-журнал информацию об операции, идентификаторе и теме обращения каждый раз при добавлении нового обращения.

			Для каждого класса доступны следующие события для обработки в рамках сервиса:

			* onAfterInsert - событие вызывается после добавления нового объекта класса
			* onBeforeDelete - событие вызывается перед удалением объекта класса
			* onAfterDelete - событие вызывается после удаления объекта класса
			* onAfterModify - событие вызвается после модификации объекта класса
			* onAfterReload - TODO/////
			* onAfterUpdate - TODO/////

			В параметр функции, вызываемой каждым событием передается дженерик-параметр IDataUpdateParams, который может быть типизирован каким-либо интерфейсом.

			Вариантом по-умолчанию можно считать IDataUpdateParams<IBaseEntity>, в таком случае в параметре невозможно будет получить значения свойств класса, вызвавшего событие. Будет доступен только его ID.

			Однако, если использовать типизацию интерфейсом того класса, чьи изменения ожидаются, например - IDataUpdateParams<ITicket>, то через свойство '''entity''' моно получить доступ к свойствам экземпляра класса.

			Также, в данном параметре передаются две коллекции - oldData и newData. В этих коллекциях можно получить изначальные и новые значения свойств объекта, при обработке событий изменения объекта.


	= Получение объекта класса по ID =		= Получение объекта класса по ID =