ЗаписьJSON / JSONWriter

Предназначен для организации последовательной записи объектов и текстов JSON.

Свойства

Параметры / Settings

• Чтение: Да
• Запись: Нет

Тип значения: ПараметрыЗаписиJSON (JSONWriterSettings)

Определяет текущие параметры записи JSON.

ПроверятьСтруктуру / ValidateStructure

• Чтение: Да
• Запись: Да

Тип значения: Булево (Boolean)

Показывает, будет ли проводиться проверка правильности структуры записываемого JSON объекта. В случае обнаружение ошибки, будет сгенерировано исключение. Например: при попытке записать значение без имени вне массива или записать окончание объекта без начала. Установка данного свойства не имеет немедленного эффекта. Установленное значение свойства будет использовано только после открытия файла или установки строки. После создания объекта данное свойство имеет значение Истина.

Методы

Закрыть / Close

Завершает запись текста JSON. Если производилась запись в файл, то файл закрывается. Если производилась запись в строку, то результирующая строка будет получена в качестве возвращаемого значения метода. Если производилась запись в файл, то метод вернет пустую строку.

Возвращаемое значение

Значения данного типа содержат строку в формате Unicode произвольной длины.

ЗаписатьБезОбработки / WriteRaw

Выполняет запись произвольной строки в документ, при этом проверка структуры документа не выполняется. Если при использовании метода свойство ПроверятьСтруктуру установлено в значение Истина, то проверка структуры продолжается на следующем элементе.

Параметры

• stringValue: Строка, записываемая в документ JSON.

ЗаписатьЗначение / WriteValue

Записывает значение свойства JSON.

Параметры

• value: Записываемое значение. Типы: Строка (String), Число (Number), Булево (Boolean), Неопределено (Undefined)
• useFormatWithExponent: Использование экспоненциальной формы записи для числовых значений. Параметр имеет смысл только если записывается значение числового типа. Значение по умолчанию: Ложь. Необязательный. Значение по умолчанию: False

ЗаписатьИмяСвойства / WritePropertyName

Записывает имя свойства JSON.

Параметры

• propertyName: Имя свойства.

ЗаписатьКонецМассива / WriteEndArray

Записывает конец массива JSON.

ЗаписатьКонецОбъекта / WriteEndObject

Записывает конец объекта JSON.

ЗаписатьНачалоМассива / WriteStartArray

Записывает начало массива JSON.

ЗаписатьНачалоОбъекта / WriteStartObject

Записывает начало объекта JSON.

ОткрытьФайл / OpenFile

Открывает файл для записи JSON. Позволяет указать тип кодировки, который будет использован для записи файла JSON, а также использование BOM.

Параметры

• fileName: Имя файла, в который будет записываться текст JSON.
• encoding: В качестве типа кодировки может быть указана одна из возможных кодировок текста. В этом случае файл будет записан в соответствующей кодировке. Если же в качестве параметра указана пустая строка или ничего не указано, то для записи файла будет использована кодировка UTF8. Поддерживаемые коды кодировок: Значение по умолчанию: UTF-8. Необязательный.
• addBOM: Определяет, будет ли добавлен маркер порядка байт (BOM) к результирующему файлу JSON. Внимание. Стандарт RFC7159 настоятельно рекомендует не добавлять маркер порядка байт (BOM) к документу JSON . Значение по умолчанию: Ложь. Необязательный. Значение по умолчанию: False
• settings: Параметры, используемые при открытии файла для настройки записи в формате JSON. Необязательный.

УстановитьСтроку / SetString

Инициализирует объект для вывода результирующего JSON текста в строку.

Параметры

• settings: Параметры, используемые при записи объекта JSON. По умолчанию, содержит ПараметрыЗаписиJSON, сгенерированные автоматически. Необязательный.

Конструкторы

Основной