Параметры, которые могут быть изменены для Сервера документов, можно подразделить на следующие основные разделы:

config — позволяет изменить тип используемой платформы, размер отображения документа (ширину и высоту), а также тип открытого документа;

  • document — содержит все параметры, относящиеся к документу (название, ссылку, тип файла, и т.д.);
    • info — содержит дополнительные параметры документа (автора документа, название папки, в которой хранится документ, дату создания, параметры обмена);
    • permissions — определяет, может ли документ быть отредактирован и скачан;
  • editorConfig — определяет параметры, относящиеся к интерфейсу редактора (режим открытия (просмотр или редактирование), язык интерфейса, дополнительные кнопки, и т.д.);
    • customization — позволяет настраивать интерфейс редактора, чтобы он выглядел как остальные ваши продукты (если они есть) и показывать или скрывать дополнительные кнопки, ссылки, изменять логотипы и информацию о владельце редактора;
    • embedded — используется только для встроенных типов документов и позволяет изменять поведение кнопок, используемых для управления встроенным режимом;
    • plugins — используется для подключения необходимых плагинов к вашему Серверу Документов, что позволит сделать их видимыми для всех пользователей, редактирующих документ;
  • events — список специальных событий, вызываемых, когда какое-либо действие применяется к документу (загрузка документа, изменение, и т.д.);

Полный config, со всеми дополнительными параметрами выглядит следующим образом:

config = {
    "document": {
        "fileType": "docx",
        "info": {
            "author": "Иван Петров",
            "created": "2010-07-07 3:46 PM",
            "folder": "Примеры файлов",
            "sharingSettings": [
                {
                    "permissions": "Полный доступ",
                    "user": "Иван Петров"
                },
                {
                    "permissions": "Только для чтения",
                    "user": "Елена Иванова"
                },
                ...
            ]
        },
        "key": "Khirz6zTPdfd7",
        "permissions": {
            "comment": true,
            "download": true,
            "edit": true,
            "fillForms": true,
            "print": true,
            "review": true
        },
        "title": "Пример названия документа.docx",
        "url": "https://example.com/url-to-example-document.docx"
    },
    "documentType": "text",
    "editorConfig": {
        "callbackUrl": "https://example.com/url-to-callback.ashx",
        "createUrl": "https://example.com/url-to-create-document/",
        "customization": {
            "autosave": true,
            "chat": true,
            "commentAuthorOnly": false,
            "compactToolbar": false,
            "customer": {
                "address": "Мой город, 123-45",
                "info": "Дополнительная информация",
                "logo": "https://example.com/logo-big.png",
                "mail": "john@example.com",
                "name": "Иван Петров и сыновья.",
                "www": "example.com"
            },
            "feedback": {
                "url": "https://example.com",
                "visible": true
            },
            "forcesave": false,
            "goback": {
                "blank": true,
                "text": "Вернуться к документам",
                "url": "https://example.com"
            },
            "help": true,
            "logo": {
                "image": "https://example.com/logo.png",
                "imageEmbedded": "https://example.com/logo_em.png",
                "url": "https://example.com"
            },
            "showReviewChanges": false,
            "zoom": 100
        },
        "embedded": {
            "embedUrl": "https://example.com/embedded?doc=exampledocument1.docx",
            "fullscreenUrl": "https://example.com/embedded?doc=exampledocument1.docx#fullscreen",
            "saveUrl": "https://example.com/download?doc=exampledocument1.docx",
            "shareUrl": "https://example.com/view?doc=exampledocument1.docx",
            "toolbarDocked": "top"
        },
        "lang": "ru-RU",
        "mode": "edit",
        "plugins": {
             "autostart": [
                 "asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
                 "asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
                 ...
             ],
             "pluginsData": [
                 "https://example.com/plugin1/config.json",
                 "https://example.com/plugin2/config.json",
                 ...
             ]
        },
        "recent": [
            {
                "folder": "Примеры файлов",
                "title": "exampledocument1.docx",
                "url": "https://example.com/exampledocument1.docx"
            },
            {
                "folder": "Примеры файлов",
                "title": "exampledocument2.docx",
                "url": "https://example.com/exampledocument2.docx"
            },
            ...
        ],
        "user": {
            "id": "78e1e841",
            "name": "Иван Петров"
        }
    },
    "events": {
        "onAppReady": onAppReady,
        "onCollaborativeChanges": onCollaborativeChanges,
        "onDocumentReady": onDocumentReady,
        "onDocumentStateChange": onDocumentStateChange,
        "onDownloadAs": onDownloadAs,
        "onError": onError,
        "onInfo": onInfo,
        "onOutdatedVersion": onOutdatedVersion,
        "onRequestClose": onRequestClose,
        "onRequestEditRights": onRequestEditRights,
        "onRequestHistory": onRequestHistory,
        "onRequestHistoryClose": onRequestHistoryClose,
        "onRequestHistoryData": onRequestHistoryData,
        "onWarning": onWarning
    },
    "height": "100%",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.t-IDcSemACt8x4iTMCda8Yhe3iZaWbvV5XKSTbuAn0M",
    "type": "desktop",
    "width": "100%"
};

Где example.com — имя сервера, на котором установлены менеджер документов и сервис хранения документов. Смотрите раздел Как это работает, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.

Была ли полезна статья?
Позвольте нам стать лучше