Hierarchy

  • CardExtensionHelper

Methods

  • Исправляет список уникальных ссылок, задаваемых идентификаторами любого типа в полях из списка identifierFieldNames в списке полей rows.

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

    Возвращает признак того, что была найдена хотя бы одна строка-дубликат. Если задано removeDuplicates как false, то дубликаты не удаляются.

    Метод гарантирует, что если пользователь удалит и тут же добавит строку с таким же идентификатором, то удалённая не будет удалена, а новая строка не будет добавлена.

    Рекомендуется использовать метод в случае, если в секции есть необходимые уникальные индексы.

    Returns

    true, если была найдена хотя бы одна строка-дубликат, false в противном случае.

    Parameters

    • rows: StorageArray<CardRow>

      Список строк. Может быть обычной карточкой, файлов или заданием.

    • identifierFieldNames: string[]

      Список имён полей в строках rows, которые содержат идентификаторы любого типа, уникальность которых требуется обеспечить в пределах списка строк, в т.ч. родительские идентификаторы.

    • parentIdentifierFieldName: null | string = null

      Имя поля в строках rows, которое содержит идентификатор для связи с родительской строкой (ParentRowID), у которых обычно указан флажок "Is reference to owner". Эти идентификаторы позволяют найти строки в пределах одной родительской строки при удалении дубликатов. Может быть указан null или пустая строка, если строки rows не принадлежат дочерней секции.

    • orderFieldName: null | string = null

      Имя поля для сортировки в строках rows или null, если поле не задано.

    • removeDuplicates: boolean = true

      Признак того, что строки-дубликаты должны быть удалены. Используйте false, чтобы найти строки, но не удалять их.

    • removeRowFunc: null | ((rows: CardRow[], row: CardRow) => void) = null

      Функция, выполняющая удаление указанной строки из коллекции строк, или null, если строка удаляется обычным образом. Переопределять удаление имеет смысл на клиенте, где также требуется удалить дочерние строки из структуры карточки.

    Returns boolean

  • Исправляет список уникальных ссылок, задаваемых идентификаторами любого типа в поле identifierFieldName в коллекционной секции с именем sectionName.

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

    Метод следует вызывать в расширении на сохранение карточки, файла или задания, передаваемого в поле card.

    Метод гарантирует, что если пользователь удалит и тут же добавит строку с таким же идентификатором в поле identifierFieldName, то удалённая не будет удалена, а новая строка не будет добавлена.

    Рекомендуется использовать метод в случае, если в секции sectionName есть уникальный индекс на идентификатор карточки и идентификатор в поле identifierFieldName.

    Parameters

    • card: Card

      Сохраняемая карточка. Может быть обычной карточкой, файлов или заданием.

    • sectionName: string

      Имя коллекционной секции, которая содержит список идентификаторов.

    • identifierFieldName: string

      Имя поля в секции sectionName, которое содержит идентификатор любого типа, уникальность которого требуется обеспечить в пределах карточки.

    • parentRowIdFieldName: null | string = null

      Имя поля в секции sectionName, которое содержит идентификатор родительской строки, уникальность которого требуется обеспечить в пределах карточки, или null, если секция sectionName не является дочерней.

    • orderFieldName: null | string = null

      Имя поля для сортировки в строках карточки или null, если поле не задано.

    • removeRowFunc: null | ((rows: CardRow[], row: CardRow) => void) = null

      Функция, выполняющая удаление указанной строки из коллекции строк, или null, если строка удаляется обычным образом. Переопределять удаление имеет смысл на клиенте, где также требуется удалить дочерние строки из структуры карточки.

    Returns void

Generated using TypeDoc