import { OutgoingContext } from './OutgoingContext';

/**
 * Сообщение с ответом на вызов метода.
 * Оно отправляется когда вызов завершен и результат был успешно получен.
 */
export interface CallAnswerMessage {
  /**
   * Идентификатор конкретной транзакции, для данного вызов метода.
   * На клиенте это значение будет использовано, чтобы отдать результат в нужное место.
   */
  transactionId: string;

  type: 'call:answer';

  /**
   * Значение полей объекта помеченных флагом out.
   * По итогу получения результат эти значения будут установлены в соответствующие поля в объект на стороне клиента.
   *
   * @todo Данное поле может содержать контекст для других экшенов, это нужно бы уточнить и описать.
   */
  context?: OutgoingContext;

  /**
   * Комментарии о происходящем, если есть смысл.
   */
  description: string;

  /**
   * Если true клиент воспринимает ответ как результат.
   * Иначе считается что пользовательский код кинул исключение и на клиенте тоже формируется исключение на основе поля result.
   */
  success: boolean;

  /**
   * Полезная нагрузка.
   */
  result: any;
}