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

378 lines
33 KiB
XML
Raw 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.Employee</name>
</assembly>
<members>
<member name="T:ASC.Api.Employee.EmployeeApi">
<summary>Доступ к профилю пользователя</summary>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetMe">
<summary>Возвращает подробные сведения о профиле текущего пользователя</summary>
<short>Мой профиль</short>
<returns>Профиль</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetAll">
<summary>Возвращает список профилей всех пользователей портала</summary>
<short>Все профили</short>
<returns>Список профилей</returns>
<remarks>Этот метод приводит к показу части профиля. Чтобы получить профиль целиком, воспользуйтесь более определенным методом</remarks>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetById(System.String)">
<summary>Возвращает подробные сведения о профиле пользователя с указанным в запросе именем</summary>
<short>Определенный профиль</short>
<param name="username">Имя пользователя</param>
<returns>Профиль пользователя</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetByEmail(System.String)">
<summary>Возвращает подробные сведения о профиле пользователя с указанным в запросе именем</summary>
<short>Определенный профиль</short>
<param name="email">Адрес пользователя</param>
<returns>Профиль пользователя</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetSearch(System.String)">
<summary>Возвращает список профилей всех пользователей портала, соответствующих поисковому запросу</summary>
<short>Выполнить поиск пользователей</short>
<param name="query">Запрос</param>
<returns>Список пользователей</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetPeopleSearch(System.String)">
<summary>Возвращает список пользователей, соответствующих поисковому запросу</summary>
<short>Поиск пользователя</short>
<param name="query">Выполнить поиск текста</param>
<returns>Список пользователей</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetAdvanced(ASC.Core.Users.EmployeeStatus,System.String)">
<summary>Возвращает список пользователей, соответствующих фильтру статуса и искомому тексту</summary>
<short>Поиск пользователя с фильтром</short>
<param name="status">Статус пользователя</param>
<param name="query">Выполнить поиск текста</param>
<returns>Список пользователей</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.SaveUsers(System.String,System.Boolean)">
<summary>Импортирует нового пользователя портала и добавляет сведения о его имени, фамилии и адресе электронной почты</summary>
<short>Добавить нового импортированного пользователя</short>
<param name="userList">Список добавляемых пользователей</param>
<param name="importUsersAsCollaborators" optional="true">Добавить пользователей как гостей (логический тип данных: false|true)</param>
<returns>Недавно созданные пользователи</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetFullByFilter(System.Nullable{ASC.Core.Users.EmployeeStatus},System.Nullable{System.Guid},System.Nullable{ASC.Core.Users.EmployeeActivationStatus},System.Nullable{ASC.Core.Users.EmployeeType},System.Nullable{System.Boolean})">
<summary>Возвращает список соответствующих фильтру пользователей с указанными в запросе параметрами</summary>
<short>Поиск пользователя с расширенным фильтром</short>
<param optional="true" name="employeeStatus">Статус пользователя</param>
<param optional="true" name="groupId">ИД группы</param>
<param optional="true" name="activationStatus">Статус активации</param>
<param optional="true" name="employeeType">Тип пользователя</param>
<param optional="true" name="isAdministrator">Администратор (логический тип данных)</param>
<returns>Список пользователей</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetSimpleByFilter(System.Nullable{ASC.Core.Users.EmployeeStatus},System.Nullable{System.Guid},System.Nullable{ASC.Core.Users.EmployeeActivationStatus},System.Nullable{ASC.Core.Users.EmployeeType},System.Nullable{System.Boolean})">
<summary>Возвращает список соответствующих фильтру пользователей с указанными в запросе параметрами</summary>
<short>Поиск пользователя с расширенным фильтром</short>
<param optional="true" name="employeeStatus">Статус пользователя</param>
<param optional="true" name="groupId">ИД группы</param>
<param optional="true" name="activationStatus">Статус активации</param>
<param optional="true" name="employeeType">Тип пользователя</param>
<param optional="true" name="isAdministrator">Администратор (логический тип данных)</param>
<returns>Список пользователей</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.AddMember(System.Boolean,System.String,System.String,System.String,System.Guid[],System.String,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact},System.String,System.String)">
<summary>Добавляет нового пользователя портала с указанными в запросе именем, фамилией, адресом электронной почты и несколькими необязательными параметрами</summary>
<short>Добавить нового пользователя</short>
<param name="isVisitor">Пользователь или посетитель (логический тип данных: false|true)</param>
<param name="email">Адрес эл. почты</param>
<param name="firstname">Имя</param>
<param name="lastname">Фамилия</param>
<param name="department" optional="true">Отдел</param>
<param name="title" optional="true">Название</param>
<param name="location" optional="true">Местоположение</param>
<param name="sex" optional="true">Пол (мужской|женский)</param>
<param name="birthday" optional="true">День рождения</param>
<param name="worksfrom" optional="true">Дата начала работы. Если она не названа, будет задана текущая дата</param>
<param name="comment" optional="true">Комментарий для пользователя</param>
<param name="contacts">Список контактов</param>
<param name="files">URL-адрес фотографии аватара</param>
<param name="password" optional="true">Пароль пользователя</param>
<returns>Недавно созданный пользователь</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.AddMemberAsActivated(System.Boolean,System.String,System.String,System.String,System.Guid[],System.String,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact},System.String,System.String)">
<summary>Добавляет нового пользователя портала с указанными в запросе именем, фамилией, адресом электронной почты и несколькими необязательными параметрами</summary>
<short>Добавить нового пользователя</short>
<param name="isVisitor">Пользователь или посетитель (логический тип данных: false|true)</param>
<param name="email">Адрес эл. почты</param>
<param name="firstname">Имя</param>
<param name="lastname">Фамилия</param>
<param name="department" optional="true">Отдел</param>
<param name="title" optional="true">Название</param>
<param name="location" optional="true">Местоположение</param>
<param name="sex" optional="true">Пол (мужской|женский)</param>
<param name="birthday" optional="true">День рождения</param>
<param name="worksfrom" optional="true">Дата начала работы. Если она не названа, будет задана текущая дата</param>
<param name="comment" optional="true">Комментарий для пользователя</param>
<param name="contacts">Список контактов</param>
<param name="files">URL-адрес фотографии аватара</param>
<param name="password">Пароль пользователя</param>
<returns>Недавно созданный пользователь</returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMember(System.Boolean,System.String,System.String,System.String,System.String,System.Guid[],System.String,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact},System.String,System.Nullable{System.Boolean})">
<summary>Обновляет данные для выбранного пользователя портала с указанными в запросе именем, фамилией, адресом электронной почты и/или необязательными параметрами</summary>
<short>Обновить пользователя</short>
<param name="isVisitor">Пользователь или посетитель (логический тип данных: false|true)</param>
<param name="userid">ИД обновляемого пользователя</param>
<param name="firstname">Имя</param>
<param name="lastname">Фамилия</param>
<param name="comment" optional="true">Комментарий для пользователя</param>
<param name="department" optional="true">Отдел</param>
<param name="title" optional="true">Название</param>
<param name="location" optional="true">Местоположение</param>
<param name="sex" optional="true">Пол (мужской|женский)</param>
<param name="birthday" optional="true">День рождения</param>
<param name="worksfrom" optional="true">Дата начала работы. Если она не названа, будет задана текущая дата</param>
<param name="contacts">Список контактов</param>
<param name="files">URL-адрес фотографии аватара</param>
<param name="disable"></param>
<returns>Недавно созданный пользователь</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.DeleteMember(System.String)">
<summary>Удаляет пользователя с указанным в запросе с портала ИД</summary>
<short>Удалить пользователя</short>
<param name="userid">ИД удаляемого пользователя</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMemberContacts(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact})">
<summary>Обновляет контактные данные указанного пользователя, объединяя отправленные данные с данными на портале</summary>
<short>Обновленные контакты пользователя</short>
<param name="userid">ИД пользователя</param>
<param name="contacts">Список контактов</param>
<returns>Обновленный профиль пользователя</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.SetMemberContacts(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact})">
<summary>Обновляет контактные данные указанного пользователя, заменяя данные на портале отправленными данными</summary>
<short>Задать контакты пользователя</short>
<param name="userid">ИД пользователя</param>
<param name="contacts">Список контактов</param>
<returns>Обновленный профиль пользователя</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.DeleteMemberContacts(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact})">
<summary>Обновляет контактные данные указанного пользователя, удаляя с портала указанные в запросе данные</summary>
<short>Удалить контакты пользователя</short>
<param name="userid">ИД пользователя</param>
<param name="contacts">Список контактов</param>
<returns>Обновленный профиль пользователя</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetMemberPhoto(System.String)">
<summary>Получить фотографии пользователя</summary>
<short>Получить фотографии пользователя</short>
<param name="userid">ИД пользователя</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMemberPhoto(System.String,System.String)">
<summary>Обновляет фотографию указанного пользователя с указанием пути</summary>
<short>Обновить фотографию пользователя</short>
<param name="userid">ИД пользователя</param>
<param name="files">URL-адрес фотографии аватара</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.DeleteMemberPhoto(System.String)">
<summary>Удаляет фотографию пользователя с указанным в запросе ИД</summary>
<short>Удалить фотографию пользователя</short>
<param name="userid">ИД пользователя</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.CreateMemberPhotoThumbnails(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>Создает эскизы фотографий с помощью координат исходного изображения</summary>
<short>Создать эскизы фотографий пользователя</short>
<param name="userid">ИД пользователя</param>
<param name="tmpFile">Путь к временному файлу</param>
<param name="x">X</param>
<param name="y">Y</param>
<param name="width">Ширина</param>
<param name="height">Высота</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.SendUserPassword(System.String)">
<summary>Напоминает пароль пользователя, адрес электронной почты которого указан в запросе</summary>
<short>Напомнить пароль пользователя</short>
<param name="email">Адрес пользователя</param>
<returns></returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.ChangeUserPassword(System.Guid,System.String,System.String)">
<summary>Задает пароль и адрес электронной почты пользователя, ИД которого указан в запросе</summary>
<param name="userid">ИД пользователя</param>
<param name="password">Пароль</param>
<param name="email">Новый адрес эл. почты</param>
<returns>Подробные сведения о пользователе</returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateEmployeeActivationStatus(ASC.Core.Users.EmployeeActivationStatus,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Задает необходимый статус активации исходя из списка пользователей с указанным в запросе ИД</summary>
<summary>Задать статус активации</summary>
<param name="userIds">ИД списка пользователей</param>
<param name="activationstatus">Необходимый статус</param>
<returns>Список пользователей</returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateUserType(ASC.Core.Users.EmployeeType,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Изменяет тип пользователя (пользователь или гость) с указанным в запросе ИД</summary>
<short>Изменение типа пользователя</short>
<param name="type">Новый тип пользователя</param>
<param name="userIds">Список ИД пользователей</param>
<returns>Список пользователей</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateUserStatus(ASC.Core.Users.EmployeeStatus,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Изменяет статус пользователя (активный или заблокированный) с указанным в запросе ИД</summary>
<short>Изменение статуса пользователя</short>
<param name="status">Новый статус пользователя</param>
<param name="userIds">Список ИД пользователей</param>
<returns>Список пользователей</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.ResendUserInvites(System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Снова отправляет сообщения пользователям, которые не активировали свои адреса электронной почты</summary>
<short>Отправить сообщение об активации</short>
<param name="userIds">Список ИД пользователей</param>
<returns>Список пользователей</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.RemoveUsers(System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Удаляет список выбранных пользователей</summary>
<short>Удалить пользователей</short>
<param name="userIds">Список ИД пользователей</param>
<returns>Список пользователей</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.SendInstructionsToDelete">
<summary>Отправляет инструкции для удаления собственного профиля пользователя</summary>
<short>Отправить инструкции по удалению</short>
<returns>Информационное сообщение</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.JoinToAffiliateProgram">
<summary>Присоединиться к Аффилиат-программе</summary>
<short>Присоединиться к Аффилиат-программе</short>
<returns>Ссылка на Аффилиат-программу</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.LinkAccount(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.UnlinkAccount(System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetReassignProgress(System.Guid)">
<summary>Возвращает ход выполнения запущенного процесса переназначения</summary>
<param name="userId">ИД пользователя, данные которого переназначаются</param>
<category>Переназначить данные пользователя</category>
<returns>Ход выполнения переназначения</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.TerminateReassign(System.Guid)">
<summary>Завершить процесс переназначения</summary>
<param name="userId">ИД пользователя, данные которого переназначаются</param>
<category>Переназначить данные пользователя</category>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.StartReassign(System.Guid,System.Guid,System.Boolean)">
<summary>Запустить процесс переназначения</summary>
<param name="fromUserId">ИД пользователя-отправителя</param>
<param name="toUserId">ИД пользователя-получателя</param>
<param name="deleteProfile">Удалить профиль по завершении переназначения</param>
<category>Переназначить данные пользователя</category>
<returns>Ход выполнения переназначения</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetRemoveProgress(System.Guid)">
<summary>Возвращает ход выполнения запущенного процесса удаления</summary>
<param name="userId">ИД пользователя</param>
<category>Удалить данные пользователя</category>
<returns>Ход выполнения удаления</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.TerminateRemove(System.Guid)">
<summary>Завершить процесс удаления</summary>
<param name="userId">ИД пользователя</param>
<category>Удалить данные пользователя</category>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.StartRemove(System.Guid)">
<summary>Начать процесс удаления</summary>
<param name="userId">ИД пользователя</param>
<category>Удалить данные пользователя</category>
<returns>Ход выполнения удаления</returns>
</member>
<member name="T:ASC.Api.Employee.GroupsApi">
<summary>Доступ к группам</summary>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.GetAll">
<summary>Возвращает общие сведения обо всех группах (например, ИД группы и сведения о менеджере группы)</summary>
<short>Все группы</short>
<returns>Список групп</returns>
<remarks>Этот метод приводит к показу части сведений о группе</remarks>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.GetById(System.Guid)">
<summary>Возвращает подробные сведения о выбранной группе: название группы, категория, описание, менеджер, пользователи и родительская группа, если она существует</summary>
<short>Определенная группа</short>
<param name="groupid">ИД группы</param>
<returns>Группа</returns>
<remarks>Этот метод приводит к показу всех сведений о группе</remarks>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.GetByUserId(System.Guid)">
<summary>Возвращает список групп для пользователя</summary>
<short>Группы пользователей</short>
<param name="userid">ИД пользователя</param>
<returns>Группа</returns>
<remarks>Этот метод приводит к показу групп пользователя</remarks>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.AddGroup(System.Guid,System.String,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Добавляет новую группу с указанными менеджером группы, названием и пользователями</summary>
<short>Добавить новую группу</short>
<param name="groupManager">Менеджер группы</param>
<param name="groupName">Название группы</param>
<param name="members">Список пользователей группы</param>
<returns>Недавно созданная группа</returns>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.UpdateGroup(System.Guid,System.Guid,System.String,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Обновляет существующую группу, изменяя менеджера группы, название и/или пользователей</summary>
<short>Обновить существующую группу</short>
<param name="groupid">ИД группы</param>
<param name="groupManager">Менеджер группы</param>
<param name="groupName">Название группы</param>
<param name="members">Список пользователей группы</param>
<returns>Недавно созданная группа</returns>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.DeleteGroup(System.Guid)">
<summary>Удаляет выбранную группу из списка групп на портале</summary>
<short>Удалить группу</short>
<param name="groupid">ИД группы</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.TransferMembersTo(System.Guid,System.Guid)">
<summary>Переместить всех пользователей из выбранной группы в другую указанную группу</summary>
<short>Переместить пользователей группы</short>
<param name="groupid">ИД исходной группы</param>
<param name="newgroupid">ИД группы назначения</param>
<returns>Сведения о группе, пользователи которой перемещены</returns>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.SetMembersTo(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Управляет пользователями группы, удаляя текущих пользователей и добавляя вместо них новых пользователей</summary>
<short>Задать пользователей группы</short>
<param name="groupid">ИД группы</param>
<param name="members">Список пользователей</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.AddMembersTo(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Добавить новых пользователей группы с сохранением текущих пользователей</summary>
<short>Добавить пользователей группы</short>
<param name="groupid">ИД группы</param>
<param name="members">Список пользователей</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.SetManager(System.Guid,System.Guid)">
<summary>Назначает пользователя с отправленным ИД менеджером выбранной группы</summary>
<short>Задать менеджера группы</short>
<param name="groupid">ИД группы</param>
<param name="userid">ИД пользователя, который станет менеджером</param>
<returns></returns>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.Employee.GroupsApi.RemoveMembersFrom(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>Удаляет указанных пользователей группы с сохранением всех текущих пользователей группы</summary>
<short>Удалить пользователей группы</short>
<param name="groupid">ИД группы</param>
<param name="members">Список пользователей</param>
<returns></returns>
</member>
</members>
</doc>