helpcenter/helpcenter.r7-office.ru/Web/Bin/ASC.Api.Portal.XML
2019-02-25 13:59:30 +03:00

204 lines
13 KiB
XML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>ASC.Api.Portal</name>
</assembly>
<members>
<member name="T:ASC.Api.Portal.PortalApi">
<summary>Доступ к сведениям о портале</summary>
</member>
<member name="M:ASC.Api.Portal.PortalApi.Get">
<summary>Возвращает текущий портал</summary>
<short>Текущий портал</short>
<returns>Портал</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetUser(System.Guid)">
<summary>Возвращает пользователя с указанным ИД из текущего портала</summary>
<short>Пользователь с указанным ИД</short>
<category>Пользователи</category>
<returns>Пользователь</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GeInviteLink(ASC.Core.Users.EmployeeType)">
<summary>Возвращает пригласительную ссылку на портал</summary>
<short>Возвращает пригласительную ссылку на портал</short>
<param name="employeeType">Пользователь или гость</param>
<category>Пользователи</category>
<returns>Пригласительная ссылка</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetShortenLink(System.String)">
<summary>Возвращает сокращенную ссылку</summary>
<param name="link">Ссылка для сокращения</param>
<returns>ссылка</returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetUsedSpace">
<summary>Возвращает используемое пространство текущего портала</summary>
<short>Используемое пространство текущего портала</short>
<category>Квота</category>
<returns>Используемое пространство</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetUsersCount">
<summary>Возвращает число пользователей текущего портала</summary>
<short>Число пользователей текущего портала</short>
<category>Пользователи</category>
<returns>Число пользователей</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetTariff">
<summary>Возвращает текущий тариф текущего портала</summary>
<short>Тариф текущего портала</short>
<category>Квота</category>
<returns>Тариф</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetQuota">
<summary>Возвращает текущую квоту текущего портала</summary>
<short>Квота текущего портала</short>
<category>Квота</category>
<returns>Квота</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetRightQuota">
<summary>Возвращает рекомендуемую квоту текущего портала</summary>
<short>Квота текущего портала</short>
<category>Квота</category>
<returns>Квота</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetFullAbsolutePath(System.String)">
<summary>Возвращает путь</summary>
<short>путь</short>
<returns>путь</returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetMessageCount">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.RemoveXmppConnection(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.AddXmppConnection(System.String,System.Byte)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetState(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.SendState(System.Byte)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.SendMessage(System.String,System.String,System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetAllStates">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetRecentMessages(System.String,System.Int32)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.Ping(System.Byte)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.RegisterMobileAppInstall(ASC.Core.Common.Notify.Push.MobileAppType)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetBackupSchedule">
<summary>Возвращает расписание резервного копирования текущего портала</summary>
<category>Резервное копирование</category>
<returns>Расписание резервного копирования</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.CreateBackupSchedule(ASC.Core.Common.Contracts.BackupStorageType,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}},System.Int32,ASC.Web.Studio.Core.Backup.BackupAjaxHandler.CronParams,System.Boolean)">
<summary>Создать расписание резервного копирования текущего портала</summary>
<param name="storageType">Тип хранилища</param>
<param name="storageParams">Параметры хранилища</param>
<param name="backupsStored">Максимальное количество сохраняемых резервных копий</param>
<param name="cronParams">Параметры Cron</param>
<param name="backupMail">Включить почту в резервную копию</param>
<category>Резервное копирование</category>
</member>
<member name="M:ASC.Api.Portal.PortalApi.DeleteBackupSchedule">
<summary>Удалить расписание резервного копирования текущего портала</summary>
<category>Резервное копирование</category>
</member>
<member name="M:ASC.Api.Portal.PortalApi.StartBackup(ASC.Core.Common.Contracts.BackupStorageType,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}},System.Boolean)">
<summary>Начать резервное копирование текущего портала</summary>
<param name="storageType">Тип хранилища</param>
<param name="storageParams">Параметры хранилища</param>
<param name="backupMail">Включить почту в резервную копию</param>
<category>Резервное копирование</category>
<returns>Ход выполнения резервного копирования</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetBackupProgress">
<summary>Возвращает ход выполнения начавшегося резервного копирования</summary>
<category>Резервное копирование</category>
<returns>Ход выполнения резервного копирования</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetBackupHistory">
<summary>Возвращает историю начавшегося резервного копирования</summary>
<category>Резервное копирование</category>
<returns>История резервного копирования</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.DeleteBackup(System.Guid)">
<summary>Удалить резервную копию с указанным ИД</summary>
<category>Резервное копирование</category>
</member>
<member name="M:ASC.Api.Portal.PortalApi.DeleteBackupHistory">
<summary>Удалить все резервные копии текущего портала</summary>
<category>Резервное копирование</category>
<returns>История резервного копирования</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.StartBackupRestore(System.String,ASC.Core.Common.Contracts.BackupStorageType,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.String}},System.Boolean)">
<summary>Начать восстановление данных текущего портала</summary>
<param name="backupId">ИД резервной копии</param>
<param name="storageType">Тип хранилища</param>
<param name="storageParams">Параметры хранилища</param>
<param name="notify">Уведомлять других о резервном копировании</param>
<category>Резервное копирование</category>
<returns>Ход выполнения восстановления</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetRestoreProgress">
<summary>Возвращает ход выполнения начавшегося восстановления</summary>
<category>Резервное копирование</category>
<returns>Ход выполнения восстановления</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetTempPath(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.UpdatePortalName(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.UpdatePortalAnalytics(System.Boolean)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.SendCongratulations(System.Guid,System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.RemoveCommentComplete(System.String,System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.CancelCommentComplete(System.String,System.String,System.Boolean)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.EditCommentComplete(System.String,System.String,System.String,System.Boolean)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetBarPromotions(System.String,System.String,System.Boolean)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.MarkBarPromotion(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetBarTips(System.String,System.Boolean,System.Boolean)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.MarkBarTip(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.DeleteBarTips">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetRandomPassword">
<summary>Получить случайный пароль</summary>
<short>Получить случайный пароль</short>
<visible>false</visible>
</member>
<member name="P:ASC.Api.Portal.PortalApi.Name">
<summary>Запись названия API</summary>
</member>
</members>
</doc>