helpcenter/helpcenter.r7-office.ru/Web/Bin/ASC.Api.Settings.xml

<?xml version="1.0" encoding="utf-8"?>
<doc>
    <assembly>
        <name>ASC.Api.Settings</name>
    </assembly>
    <members>
        <member name="T:ASC.Api.Settings.SettingsApi">
            <summary>Настройки портала</summary>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetSmtpSettings">
            <summary>Возвращает настройки SMTP текущего портала</summary>
            <short>Получить настройки SMTP</short>
            <returns>Данные SmtpSettings</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SaveSmtpSettings(ASC.Api.Settings.Smtp.SmtpSettingsWrapper)">
            <summary>Сохранить настройки SMTP для текущего портала</summary>
            <short>Сохранить настройки SMTP</short>
            <param name="smtpSettings">Данные настроек SMTP</param>
            <returns>Данные SmtpSettings</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.ResetSmtpSettings">
            <summary>Сброс настроек SMTP для текущего портала</summary>
            <short>Сбросить настройки SMTP</short>
            <returns>Данные SmtpSettings</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.TestSmtpSettings">
            <summary>Проверить настройки SMTP для текущего портала (отправить тестовое сообщение по адресу электронной почты пользователя)</summary>
            <short>Проверить настройки SMTP</short>
            <returns>Данные SmtpOperationStatus</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetSmtpOperationStatus">
            <summary>Возвращает статус процесса проверки SMTP</summary>
            <short>Получить статус процесса проверки SMTP</short>
            <returns>Объект SmtpOperationStatus</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetSsoSettingsV2">
            <summary>Возвращает текущие настройки SSO портала</summary>
            <short>Получить настройки SSO</short>
            <returns>Объект SsoSettingsV2</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetDefaultSsoSettingsV2">
            <summary>Возвращает настройки SSO по умолчанию для портала</summary>
            <short>Получить настройки SSO по умолчанию</short>
            <returns>Объект SsoSettingsV2</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetSsoSettingsV2Constants">
            <summary>Возвращает константы настроек SSO</summary>
            <short>Получить константы настроек SSO</short>
            <returns>объект</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SaveSsoSettingsV2(System.String)">
            <summary>Сохранить настройки SSO для текущего портала</summary>
            <short>Сохранить настройки SSO</short>
            <param name="serializeSettings">сериализованный объект SsoSettingsV2</param>
            <returns>Объект SsoSettingsV2</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.ResetSsoSettingsV2">
            <summary>Сброс настроек SSO для текущего портала</summary>
            <short>Сброс настроек SSO</short>
            <returns>Объект SsoSettingsV2</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetLdapSettings">
            <summary>Возвращает настройки LDAP текущего портала</summary>
            <short>Получить настройки LDAP</short>
            <returns>Объект LDAPSupportSettings</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetLdapCronSettings">
            <summary>Возвращает выражение Cron для автоматической синхронизации LDAP текущего портала, если оно имеется</summary>
            <short>Получить выражение Cron для LDAP AutoSync</short>
            <returns>строка или пустое значение</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SetLdapCronSettings(System.String)">
            <summary>Задает выражение Cron для автоматической синхронизации LDAP текущего портала</summary>
            <short>Задать выражение Cron для LDAP AutoSync</short>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SyncLdap">
            <summary>Начать синхронизировать процессы пользователей и групп согласно LDAP</summary>
            <short>Синхронизировать LDAP</short>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.TestLdapSync">
            <summary>Запускает процесс сбора предварительных изменений на портале согласно выбранным настройкам LDAP</summary>
            <short>Синхронизировать LDAP</short>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SaveLdapSettings(System.String,System.Boolean)">
            <summary>Сохранить настройки LDAP и начать импорт/синхронизацию процессов пользователей и групп согласно LDAP</summary>
            <short>Сохранить настройки LDAP</short>
            <param name="settings">Сериализованная строка LDAPSupportSettings</param>
            <param name="acceptCertificate">Флаг разрешает ошибки при проверке сертификатов</param>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.TestLdapSave(System.String,System.Boolean)">
            <summary>Начинает процесс сбора предварительных изменений на портале согласно настройкам LDAP</summary>
            <short>Сохранить настройки LDAP</short>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetLdapOperationStatus">
            <summary>Возвращает статус процесса синхронизации LDAP</summary>
            <short>Получить статус процесса синхронизации LDAP</short>
            <returns>Объект LDAPSupportSettingsResult</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetDefaultLdapSettings">
            <summary>Возвращает настройки LDAP по умолчанию</summary>
            <short>Получить настройки LDAP по умолчанию</short>
            <returns>Объект LDAPSupportSettings</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetSettings">
            <summary>Возвращает список всех имеющихся настроек портала с текущими значениями каждой настройки</summary>
            <short>Настройки портала</short>
            <returns>Настройки</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetQuotaUsed">
            <summary>Возвращает квоту использования пространства для портала и сведения об использовании пространства каждого модуля</summary>
            <short>Использование пространства</short>
            <returns>Использование пространства и ограничения для загрузки на серверы</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.RecalculateQuota">
            <summary>Запустить задачу пересчета квоты</summary>
            <short>Пересчитать квоту</short>
            <returns></returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.CheckRecalculateQuota">
            <summary>Проверить задачу пересчета квоты</summary>
            <short>Проверить задачу пересчета квоты</short>
            <returns>Статус проверки задачи пересчета квоты</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetBuildVersions">
            <summary>Получить версию сборки</summary>
            <visible>false</visible>
            <returns>Текущие версии сервера совместной работы, редактора и почтового сервера</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetVersions">
            <summary>Получить список доступных версий портала, включая текущую версию</summary>
            <short>Версии портал</short>
            <visible>false</visible>
            <returns>Список доступных версий портала, включая текущую версию</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SetVersion(System.Int32)">
            <summary>Выбрать версию с указанным в запросе ИД в качестве текущей версии портала</summary>
            <short>Изменить версию портала</short>
            <param name="versionId">ИД версии</param>
            <visible>false</visible>
            <returns>Список доступных версий портала, включая текущую версию</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetWebItemSecurityInfo(System.Collections.Generic.IEnumerable{System.String})">
            <summary>Возвращает настройки безопасности продукта, модуля или надстроек</summary>
            <short>Получить настройки безопасности</short>
            <param name="ids">Список ИД модулей</param>
            <returns></returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetEnabledModules">
            <summary>Возвращает список включенных модулей</summary>
            <short>Включенные модули</short>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetPasswordSettings">
            <summary>Получить настройки пароля портала</summary>
            <short>Настройки пароля</short>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SetWebItemSecurity(System.String,System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
            <summary>Задать настройки безопасности продукта, модуля или надстроек</summary>
            <short>Задать настройки безопасности</short>
            <param name="id">ИД модуля</param>
            <param name="enabled">Включен</param>
            <param name="subjects">Список ИД пользователей (групп)</param>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SetAccessToWebItems(System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.Boolean}})">
            <summary>Определяет доступ к продуктам, модулям или надстройкам</summary>
            <short>Задать доступ</short>
            <param name="items"></param>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetLogo">
            <summary>Получить URL-адрес изображения для логотипа портала</summary>
            <short>Логотип портала</short>
            <returns>URL-адрес изображения для логотипа портала</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SaveWhiteLabelSettings(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}})">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SaveWhiteLabelSettingsFromFiles(System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetWhiteLabelSizes">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetWhiteLabelLogos(System.Boolean)">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetWhiteLabelLogoText">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.RestoreWhiteLabelOptions">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetIpRestrictions">
            <summary>Получить ограничения IP-адресов портала</summary>
            <returns></returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SaveIpRestrictions(System.Collections.Generic.IEnumerable{System.String})">
            <summary>сохранить новые ограничения IP-адресов портала</summary>
            <param name="ips">ограничения IP-адресов</param>
            <returns></returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.UpdateIpRestrictionsSettings(System.Boolean)">
            <summary>обновить настройки ограничений IP-адресов</summary>
            <param name="enable">включить настройки ограничений IP-адресов</param>
            <returns></returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.UpdateTipsSettings(System.Boolean)">
            <summary>обновить настройки советов</summary>
            <param name="show">показывать пользователю советы</param>
            <returns></returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.UpdateTipsSubscription">
            <summary>изменить подписку на советы и приемы</summary>
            <returns>состояние подписки</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.CompleteWizard">
            <summary>Завершить работу мастера</summary>
            <returns>WizardSettings</returns>
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.TfaSettings(System.String)">
            <summary>Обновить настройки двухфакторной аутентификации</summary>
            <param name="type">SMS, приложение или отсутствуют</param>
            <returns>true в случае успеха</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.TfaAppGetCodes">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.TfaAppRequestNewCodes">
            <summary>Запрашивает новые коды резервного копирования для приложения с двухфакторной аутентификацией</summary>
            <returns>Новые коды резервного копирования</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.TfaAppNewApp(System.Guid)">
            <summary>Отвязывает текущее приложение с двухфакторной аутентификацией</summary>
            <returns>URL-адрес логина</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.CloseWelcomePopup">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SaveColorTheme(System.String)">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.TimaAndLanguage(System.String,System.String)">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.SaveDefaultPageSettings(System.String)">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.RefreshLicense">
            <summary>Обновить лицензию</summary>
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetCustomNavigationItems">
            <summary>Получить настраиваемые элементы навигации</summary>
            <returns>Список CustomNavigationItem</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetCustomNavigationItemSample">
            <summary>Получить пример настраиваемых элементов навигации</summary>
            <returns>Пример CustomNavigationItem</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetCustomNavigationItem(System.Guid)">
            <summary>Получить настраиваемый элемент навигации по ИД</summary>
            <param name="id">ИД элемента</param>
            <returns>CustomNavigationItem</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.CreateCustomNavigationItem(ASC.Web.Studio.Core.CustomNavigationItem)">
            <summary>Добавить настраиваемый элементы навигации</summary>
            <param name="item">Элемент</param>
            <returns>CustomNavigationItem</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.DeleteCustomNavigationItem(System.Guid)">
            <summary>Удалить настраиваемый элемент навигации по ИД</summary>
            <param name="id">ИД элемента</param>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.UpdateEmailActivationSettings(System.Boolean)">
            <summary>обновить настройки активации по электронной почте</summary>
            <param name="show">показать панель активации пользователя по электронной почте</param>
            <returns></returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetCompanyWhiteLabelSettings">
            <visible>false</visible>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetSpaceUsageStatistics(System.Guid)">
            <summary>Получить статистику использования пространства WebItem</summary>
            <param name="id">ИД WebItem</param>
            <returns>Список UsageSpaceStatItemWrapper</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetVisitStatistics(ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
            <summary>Получить статистику посещений пользователя</summary>
            <param name="fromDate">Начальная дата</param>
            <param name="toDate">Конечная дата</param>
            <returns>Список ChartPointWrapper</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetAllStorages">
            <summary>Получить хранилище</summary>
            <returns>Получатель</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetStorageProgress">
            <summary>Получить хранилище</summary>
            <returns>Получатель</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.UpdateStorage(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}})">
            <summary>Получить хранилище</summary>
            <returns>Получатель</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetAllCdnStorages">
            <summary>Получить хранилище</summary>
            <returns>Получатель</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.UpdateCdn(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}})">
            <summary>Получить хранилище</summary>
            <returns>Получатель</returns>
        </member>
        <member name="M:ASC.Api.Settings.SettingsApi.GetAllBackupStorages">
            <summary>Получить хранилище</summary>
            <returns>Получатель</returns>
        </member>
    </members>
</doc>