726 lines
53 KiB
XML
726 lines
53 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<doc>
|
||
<assembly>
|
||
<name>ASC.Api.Community</name>
|
||
</assembly>
|
||
<members>
|
||
<member name="T:ASC.Api.Community.CommunityApi">
|
||
<summary>Обеспечивает доступ к API данных сообщества</summary>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.#ctor(ASC.Api.Impl.ApiContext)">
|
||
<summary>Constructor</summary>
|
||
<param name="context"></param>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetPosts">
|
||
<summary>Возвращает список всех записей в блогах на портале с заголовком записи, датами создания и обновления, текстом записи, ИД автора и отображаемым названием</summary>
|
||
<short>Все записи</short>
|
||
<returns>Список всех записей</returns>
|
||
<category>Блоги</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.CreatePost(System.String,System.String,System.String,System.Boolean)">
|
||
<summary>Создает запись в блоге с указанным заголовком, контентом, тегами и подпиской на комментарии, определенной в теле запроса</summary>
|
||
<short>Создать запись</short>
|
||
<param name="title">Заголовок новой записи</param>
|
||
<param name="content">Текст новой записи</param>
|
||
<param name="tags">Список тегов, разделенных запятой</param>
|
||
<param name="subscribeComments">Подписаться на комментарии к записи</param>
|
||
<returns>Только что созданная запись</returns>
|
||
<example>
|
||
<![CDATA[Отправка данных методом application/json:
|
||
|
||
{
|
||
title:"Моя запись",
|
||
content:"Контент записи",
|
||
tags:"Я,Запись,Новости",
|
||
subscribeComments: "true"
|
||
}
|
||
|
||
Отправка данных методом application/x-www-form-urlencoded
|
||
title="Моя запись"&content="Контент записи"&tags="Я,Запись,Новости"&subscribeComments="true"]]>
|
||
</example>
|
||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
|
||
<category>Блоги</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UpdatePost(System.Guid,System.String,System.String,System.String)">
|
||
<summary>Обновляет указанную запись, изменяя заголовок записи, контент и/или определенные теги</summary>
|
||
<short>Обновить запись</short>
|
||
<param name="postid">ИД записи</param>
|
||
<param name="title">новый заголовок</param>
|
||
<param name="content">новый текст записи</param>
|
||
<param name="tags">список тегов, разделенный запятой</param>
|
||
<returns>Обновленный список</returns>
|
||
<example>
|
||
<![CDATA[
|
||
Отправка данных методом application/json:
|
||
{
|
||
title:"Моя запись",
|
||
content:"Контент записи",
|
||
tags:"Я,Запись,Новости"
|
||
}
|
||
|
||
Отправка данных методом application/x-www-form-urlencoded
|
||
title="Моя запись"&content="Контент записи"&tags="Я,Запись,Новости»
|
||
]]>
|
||
|
||
</example>
|
||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
|
||
<category>Блоги</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.DeletePost(System.Guid)">
|
||
<summary>Удаляет из блогов выбранную запись</summary>
|
||
<short>Удалить запись</short>
|
||
<param name="postid">ИД удаляемой записи</param>
|
||
<returns>Ничего</returns>
|
||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
|
||
<category>Блоги</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetMyPosts">
|
||
<summary>Возвращает список всех записей блога для текущего пользователя с заголовком записи, датами создания и обновления, текстом записи, ИД автора и отображаемым названием</summary>
|
||
<category>Блоги</category>
|
||
<short>Мои записи</short>
|
||
<returns>Список моих записей</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetSearchPosts(System.String)">
|
||
<summary>Возвращает список совпадающих с поисковым запросом записей блога с заголовком записи, датами создания и обновления, текстом записи, а также сведениями об авторе</summary>
|
||
<category>Блоги</category>
|
||
<short>Поиск записей</short>
|
||
<param name="query">поисковой запрос</param>
|
||
<returns>Список найденных записей</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetUserPosts(System.String)">
|
||
<summary>Возвращает список созданных определенным пользователем записей блога с заголовком записи, датами создания и обновления, а также текстом записи</summary>
|
||
<short>Записи пользователя</short>
|
||
<category>Блоги</category>
|
||
<param name="username" remark="You can retrieve username through 'people' api">Имя пользователя</param>
|
||
<returns>Список записей пользователя</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetPostsByTag(System.String)">
|
||
<summary>Возвращает список записей блога, содержащих указанный тег, с заголовком записи, датами создания и обновления, текстом записи, а также сведениями об авторе</summary>
|
||
<short>По тегу</short>
|
||
<category>Блоги</category>
|
||
<param name="tag">название тега</param>
|
||
<returns>Список записей с определенным названием тега</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetTags">
|
||
<summary>Возвращает список всех тегов, которыми помечены записи блога, с заголовком записи, датами создания и обновления, текстом записи, а также сведениями об авторе и всех примененных тегах</summary>
|
||
<category>Блоги</category>
|
||
<short>Теги</short>
|
||
<returns>Список тегов</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetPost(System.Guid)">
|
||
<summary>Возвращает подробные сведения о записи блога с указанным в запросе ИД</summary>
|
||
<short>Определенная запись</short>
|
||
<category>Блоги</category>
|
||
<param name="postid">ИД записи</param>
|
||
<returns>запись</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetComments(System.Guid)">
|
||
<summary>Возвращает список всех комментариев к записи блога с указанным в запросе ИД</summary>
|
||
<category>Блоги</category>
|
||
<short>Получить комментарии</short>
|
||
<param name="postid">ИД (GUID) записи</param>
|
||
<returns>список комментариев к записи</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddComment(System.Guid,System.String,System.Guid)">
|
||
<summary>Добавляет комментарий к указанной записи с определенным текстом. При необходимости можно также указать ИД родительского комментария.</summary>
|
||
<short>Добавить комментарий</short>
|
||
<category>Блоги</category>
|
||
<param name="postid">ИД записи</param>
|
||
<param name="content">текст комментария</param>
|
||
<param name="parentId">ИД родительского комментария</param>
|
||
<returns>Список комментариев к записи</returns>
|
||
<example>
|
||
<![CDATA[
|
||
Отправка данных в application/json:
|
||
|
||
{
|
||
content:"Мой комменатрий",
|
||
parentId:"9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||
}
|
||
|
||
Отправка данных методом application/x-www-form-urlencoded
|
||
content="Мой комменатрий"&parentId="9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||
]]>
|
||
</example>
|
||
<remarks>Отправьте parentId=00000000-0000-0000-0000-000000000000 или вообще не отправляйте этот параметр, если вы хотите, чтобы ваш комментарий был на корневом уровне</remarks>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetBlogCommentPreview(System.String,System.String)">
|
||
<summary>Получить предварительный просмотр комментария с указанным в запросе контентом</summary>
|
||
<short>Получить предварительный просмотр комментария </short>
|
||
<section>Комментарии</section>
|
||
<param name="commentid">ИД комментария</param>
|
||
<param name="htmltext">Контент комментария</param>
|
||
<returns>Сведения о комментарии</returns>
|
||
<category>Блоги</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.RemoveBlogComment(System.String)">
|
||
<summary>Удалить комментарий с указанным в запросе ИД</summary>
|
||
<short>Удалить комментарий</short>
|
||
<section>Комментарии</section>
|
||
<param name="commentid">ИД комментария</param>
|
||
<returns>ИД комментария</returns>
|
||
<category>Блоги</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddBlogComment(System.String,System.String,System.String)">
|
||
<category>Блоги</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UpdateBlogComment(System.String,System.String)">
|
||
<category>Блоги</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarks">
|
||
<summary>Возвращает список всех закладок на портале с заголовками закладок, датами создания и обновления, текстом закладки и сведениями об авторе</summary>
|
||
<short>Все закладки</short>
|
||
<category>Закладки</category>
|
||
<returns>Список всех закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetMyBookmarks">
|
||
<summary>Возвращает список всех закладок для текущего пользователя с заголовками закладок, датами создания и обновления, текстом закладки и сведениями об авторе</summary>
|
||
<short>Добавленные мной</short>
|
||
<category>Закладки</category>
|
||
<returns>Список закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.SearchBookmarks(System.String)">
|
||
<summary>Возвращает список закладок, совпадающих с поисковым запросом, с заголовками закладок, датами создания и обновления, описанием закладки и сведениями об авторе</summary>
|
||
<short>Найти</short>
|
||
<category>Закладки</category>
|
||
<param name="query">поисковый запрос</param>
|
||
<returns>Список закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetFavsBookmarks">
|
||
<summary>Возвращает список избранных закладок для текущего пользователя с заголовками закладок, датами создания и обновления, текстом закладки и сведениями об авторе</summary>
|
||
<short>Мое избранное</short>
|
||
<category>Закладки</category>
|
||
<returns>Список закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarksTags">
|
||
<summary>Возвращает список всех тегов, использованных для закладок, с числом, отражающим использование тега</summary>
|
||
<short>Все теги</short>
|
||
<category>Закладки</category>
|
||
<returns>Список тегов</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarksByTag(System.String)">
|
||
<summary>Возвращает список всех закладок, отмеченных указанным тегом, с заголовками закладок, датами создания и обновления, текстом закладки и сведениями об авторе</summary>
|
||
<short>По тегу</short>
|
||
<category>Закладки</category>
|
||
<param name="tag">тег</param>
|
||
<returns>Список закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetRecentBookmarks">
|
||
<summary>Возвращает список недавно добавленных закладок с заголовками закладок, датами создания и обновления, текстом закладки и сведениями об авторе</summary>
|
||
<short>Недавно добавленные</short>
|
||
<category>Закладки</category>
|
||
<returns>Список закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetTopDayBookmarks">
|
||
<summary>Возвращает список наиболее популярных за текущий день закладок с заголовками закладок, датами создания и обновления, текстом закладки и сведениями об авторе</summary>
|
||
<short>Топ дня</short>
|
||
<category>Закладки</category>
|
||
<returns>Список закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetTopMonthBookmarks">
|
||
<summary>Возвращает список наиболее популярных за текущий месяц закладок с заголовками закладок, датами создания и обновления, текстом закладки и сведениями об авторе</summary>
|
||
<short>Топ месяца</short>
|
||
<category>Закладки</category>
|
||
<returns>Список закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetTopWeekBookmarks">
|
||
<summary>Возвращает список наиболее популярных за текущую неделю закладок с заголовками закладок, датами создания и обновления, текстом закладки и сведениями об авторе</summary>
|
||
<short>Топ недели</short>
|
||
<category>Закладки</category>
|
||
<returns>список закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetTopYearBookmarks">
|
||
<summary>Возвращает список наиболее популярных за текущий год закладок с заголовками закладок, датами создания и обновления, текстом закладки и сведениями об авторе</summary>
|
||
<short>Топ года</short>
|
||
<category>Закладки</category>
|
||
<returns>список закладок</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarkComments(System.Int64)">
|
||
<summary>Возвращает список всех комментариев к закладке с указанным ИД</summary>
|
||
<short>Получить комментарии</short>
|
||
<category>Закладки</category>
|
||
<param name="id">ИД закладки</param>
|
||
<returns>список комментариев к закладке</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddBookmarkComment(System.Int64,System.String,System.Guid)">
|
||
<summary>Добавляет комментарий к закладке с указанным ИД. При необходимости можно также указать ИД родительской закладки.</summary>
|
||
<short>Добавить комментарий</short>
|
||
<param name="id">ИД закладки</param>
|
||
<param name="content">контент комментария</param>
|
||
<param name="parentId">ИД родительского комментария</param>
|
||
<returns>список комментариев к закладке</returns>
|
||
<example>
|
||
<![CDATA[
|
||
Отправка данных методом application/json:
|
||
|
||
{
|
||
content:"Мой комментарий",
|
||
parentId:"9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||
}
|
||
|
||
Отправка данных методом application/x-www-form-urlencoded
|
||
content="Мой комментарий"&parentId="9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||
]]>
|
||
</example>
|
||
<remarks>Отправьте parentId=00000000-0000-0000-0000-000000000000 или вообще не отправляйте этот параметр, если вы хотите, чтобы ваш комментарий был на корневом уровне</remarks>
|
||
<category>Закладки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarkById(System.Int64)">
|
||
<summary>Возвращает подробные сведения о закладке с указанным ИД</summary>
|
||
<short>Получить закладки по ИД</short>
|
||
<param name="id">ИД закладки</param>
|
||
<returns>закладка</returns>
|
||
<category>Закладки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddBookmark(System.String,System.String,System.String,System.String)">
|
||
<summary>Добавляет закладку с указанным названием, описанием и тегами</summary>
|
||
<short>Добавить закладку</short>
|
||
<param name="url">адрес страницы закладки</param>
|
||
<param name="title">отображаемое название</param>
|
||
<param name="description">описание</param>
|
||
<param name="tags">теги, разделенные точкой с запятой</param>
|
||
<returns>недавно добавленная закладка</returns>
|
||
<example>
|
||
<![CDATA[
|
||
Отправка данных методом application/json:
|
||
|
||
{
|
||
url:"www.r7-office.ru",
|
||
title: "Р7-Офис",
|
||
description: "лучший сайт из тех, что я видел",
|
||
tags: "управление проектами, совместная работа"
|
||
}
|
||
|
||
Отправка данных методом application/x-www-form-urlencoded
|
||
url="www.r7-office.ru"&title="Р7-Офис"&description="лучший сайт из тех, что я видел"&tags="управление проектами, совместная работа»
|
||
]]>
|
||
</example>
|
||
<category>Закладки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarkCommentPreview(System.String,System.String)">
|
||
<summary>Получить предварительный просмотр комментария с указанным в запросе контентом</summary>
|
||
<short>Получить предварительный просмотр комментария</short>
|
||
<section>Комментарии</section>
|
||
<param name="commentid">ИД комментария</param>
|
||
<param name="htmltext">Контент комментария</param>
|
||
<returns>Сведения о комментарии</returns>
|
||
<category>Закладки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.RemoveBookmarkComment(System.String)">
|
||
<summary>Удалить комментарий с указанным в запросе ИД</summary>
|
||
<short>Удалить комментарий</short>
|
||
<section>Комментарии</section>
|
||
<param name="commentid">ИД комментария</param>
|
||
<returns>ИД комментария</returns>
|
||
<category>Закладки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddBookmarkComment(System.String,System.Int64,System.String)">
|
||
<category>Закладки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UpdateBookmarkComment(System.String,System.String)">
|
||
<category>Закладки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.RemoveBookmarkFromFavourite(System.Int64)">
|
||
<summary>Удаляет закладку из избранных. Если после удаления пользовательский рейтинг этой закладки — 0, закладка будет окончательно удалена.</summary>
|
||
<short>Удаляет закладку из избранных</short>
|
||
<param name="id">ИД закладки</param>
|
||
<returns>закладка</returns>
|
||
<category>Закладки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.RemoveBookmark(System.Int64)">
|
||
<summary>Удаляет закладку</summary>
|
||
<short>Удаляет закладку</short>
|
||
<param name="id">ИД закладки</param>
|
||
<category>Закладки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetEvents">
|
||
<summary>Возвращает список всех событий на портале с названиями событий, датами создания и обновления, текстом события и сведениями об авторе</summary>
|
||
<short>Все события</short>
|
||
<returns>список событий</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.CreateEvent(System.String,System.String,ASC.Web.Community.News.Code.FeedType)">
|
||
<summary>Создает новое событие с указанными в запросе параметрами (названием, контентом, типом)</summary>
|
||
<short>Создать событие</short>
|
||
<param name="title">Заголовок</param>
|
||
<param name="content">Контент</param>
|
||
<param name="type">Тип. 1 из (новость|заказ|объявление|опрос)</param>
|
||
<returns>Новое созданное событие</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UpdateEvent(System.Int32,System.String,System.String,ASC.Web.Community.News.Code.FeedType)">
|
||
<summary>Обновляет выбранное событие, изменяя указанное название события, его контент и/или тип</summary>
|
||
<short>Обновить событие</short>
|
||
<param name="feedid">ИД веб-канала</param>
|
||
<param name="title">Заголовок</param>
|
||
<param name="content">Контент</param>
|
||
<param name="type">Тип</param>
|
||
<returns>Список событий</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetMyEvents">
|
||
<summary>Возвращает список всех событий для текущего пользователя с названиями событий, датами создания и обновления, текстом события и сведениями об авторе</summary>
|
||
<short>Мои события</short>
|
||
<returns>Список событий</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.SearchEvents(System.String)">
|
||
<summary>Возвращает список совпадающих с поисковым запросом событий с названием события, датами создания и обновления, типом события и сведениями об авторе</summary>
|
||
<short>Поиск</short>
|
||
<param name="query">поисковой запрос</param>
|
||
<returns>Список событий</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetEvent(System.Int32)">
|
||
<summary>Возвращает подробные сведения о событии с указанным ИД</summary>
|
||
<short>Определенное событие</short>
|
||
<param name="feedid">ИД события</param>
|
||
<returns>Событие</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetEventComments(System.Int32)">
|
||
<summary>Возвращает подробные сведения о комментариях к событию с указанным ИД</summary>
|
||
<short>Получить комментарии</short>
|
||
<param name="feedid">ИД события</param>
|
||
<returns>Список комментариев</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddEventComments(System.Int32,System.String,System.Int64)">
|
||
<summary>Добавляет комментарий к событию с указанным ИД. При необходимости можно также указать ИД родительского события.</summary>
|
||
<short>Добавить комментарий</short>
|
||
<param name="feedid">ИД события</param>
|
||
<param name="content">Контент комментария</param>
|
||
<param name="parentId">ИД родительского комментария</param>
|
||
<returns>Список комментариев</returns>
|
||
<example>
|
||
<![CDATA[
|
||
Отправка данных методом application/json:
|
||
|
||
{
|
||
content:"Мой комментарий",
|
||
parentId:"9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||
}
|
||
|
||
Отправка данных методом application/x-www-form-urlencoded
|
||
content="Мой комментарий"&parentId="9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||
]]>
|
||
</example>
|
||
<remarks>Отправьте parentId=0 или вообще не отправляйте этот параметр, если вы хотите, чтобы ваш комментарий был на корневом уровне</remarks>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.VoteForEvent(System.Int32,System.Int64[])">
|
||
<summary>Отправляет голос за определенный вариант события с указанным ИД, тип которого — опрос</summary>
|
||
<short>Голосовать за событие</short>
|
||
<param name="feedid">ИД события</param>
|
||
<param name="variants">Варианты</param>
|
||
<returns>Событие</returns>
|
||
<exception cref="T:System.ArgumentException">Появляется, если это не опрос</exception>
|
||
<exception cref="T:System.Exception">Общая ошибка</exception>
|
||
<example>
|
||
<![CDATA[
|
||
Отправка данных методом application/json:
|
||
{
|
||
variants:[1,2,3],
|
||
}
|
||
Отправка данных методом application/x-www-form-urlencoded
|
||
variants=[1,2,3]
|
||
]]>
|
||
</example>
|
||
<remarks>Если событие не является опросом, вы увидите сообщение об ошибке</remarks>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.SubscribeOnComments(System.Boolean,System.String)">
|
||
<summary>Подписаться на комментарии или отписаться от комментариев к событию с указанным ИД</summary>
|
||
<short>Подписаться на комментарии/отписаться от комментариев</short>
|
||
<param name="isSubscribe">уже подписан(а) или отменил(а) подписку </param>
|
||
<param name="feedid">ИД веб-канала</param>
|
||
<returns>Логическое значение</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetEventCommentPreview(System.String,System.String)">
|
||
<summary>Получить предварительный просмотр комментария с контентом, указанным в запросе</summary>
|
||
<short>Получить предварительный просмотр комментария</short>
|
||
<section>Комментарии</section>
|
||
<param name="commentid">ИД комментария</param>
|
||
<param name="htmltext">Контент комментария</param>
|
||
<returns>Сведения о комментарии</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.RemoveEventComment(System.String)">
|
||
<summary>Удалить комментарий с указанным в запросе ИД</summary>
|
||
<short>Удалить комментарий</short>
|
||
<section>Комментарии</section>
|
||
<param name="commentid">ИД комментария</param>
|
||
<returns>Сведения о комментарии</returns>
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddEventComment(System.String,System.String,System.String)">
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UpdateComment(System.String,System.String)">
|
||
<category>События</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetForums">
|
||
<summary>Возвращает список всех созданных на портале форумов с названиями тем/веток, датами создания и обновления, текстом записи, ИД автора и отображаемым именем</summary>
|
||
<short>Список форумов</short>
|
||
<returns>Перечень форумов</returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetForumsCount">
|
||
<summary>Возвращает количество всех созданных на портале форумов</summary>
|
||
<short>Число форумов</short>
|
||
<returns>Количество форумов</returns>
|
||
<visible>false</visible>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetThreadTopics(System.Int32)">
|
||
<summary>Возвращает список всех тем ветки в форумах на портале с названием ветки, датами создания и обновления, текстом записи, ИД автора и отображаемым именем</summary>
|
||
<short>Темы ветки</short>
|
||
<param name="threadid">ИД ветки</param>
|
||
<returns>Список тем в ветке</returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetLastTopics">
|
||
<summary>Возвращает список всех недавно обновленных тем форумов на портале с названием ветки, датами создания и обновления, текстом записи и сведениями об авторе</summary>
|
||
<short>Последние обновленные темы</short>
|
||
<returns></returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetTopicPosts(System.Int32)">
|
||
<summary>Возвращает список всех записей в выбранной ветке форумов на портале с названием ветки, датами создания и обновления, текстом записи, ИД автора и отображаемым именем</summary>
|
||
<short>Записи</short>
|
||
<param name="topicid">ИД темы</param>
|
||
<returns>Список записей в теме</returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddThreadToCategory(System.Int32,System.String,System.String,System.String)">
|
||
<summary>Добавить ветку в категорию</summary>
|
||
<short>Добавить ветку в категорию</short>
|
||
<param name="categoryId">ИД категории (-1 означает новую категорию)</param>
|
||
<param name="categoryName">Название категории</param>
|
||
<param name="threadName">Название ветки</param>
|
||
<param name="threadDescription">Описание ветки</param>
|
||
<returns>Добавленная ветка</returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddTopic(System.Int32,System.String,System.String,ASC.Forum.TopicType)">
|
||
<summary>Добавляет новую тему в существующую ветку с указанным предметом обсуждения, контентом и типом темы</summary>
|
||
<short>Добавить тему в ветку</short>
|
||
<param name="subject">Предмет обсуждения темы</param>
|
||
<param name="threadid">ИД ветки, куда выполняется добавление</param>
|
||
<param name="content">Текст темы</param>
|
||
<param name="topicType">Тип темы</param>
|
||
<returns>Добавленная тема</returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UpdateTopic(System.Int32,System.String,System.Boolean,System.Boolean)">
|
||
<summary>Обновляет тему в существующей ветке, изменяя предмет обсуждения в ветке, а также прилепляя или закрывая тему</summary>
|
||
<short>Обновить тему в ветке</short>
|
||
<param name="topicid">ИД обновляемой темы</param>
|
||
<param name="subject">Тема</param>
|
||
<param name="sticky">Прилепленная</param>
|
||
<param name="closed">Закрыть тему</param>
|
||
<returns>Обновленная тема</returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddTopicPosts(System.Int32,System.Int32,System.String,System.String)">
|
||
<summary>Добавляет запись в существующую тему с указанными в запросе предметом обсуждения записи и контентом</summary>
|
||
<short>Добавить запись в тему</short>
|
||
<param name="topicid">ИД темы</param>
|
||
<param name="parentPostId">ИД родительской записи</param>
|
||
<param name="subject">Предмет обсуждения записи (обязательный)</param>
|
||
<param name="content">Текст записи</param>
|
||
<returns>Новая запись</returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UpdateTopicPosts(System.Int32,System.Int32,System.String,System.String)">
|
||
<summary>Обновляет запись в существующей теме, изменяя предмет обсуждения записи и/или контент</summary>
|
||
<short>Обновить запись в теме</short>
|
||
<param name="topicid">ИД темы</param>
|
||
<param name="postid">ИД обновляемой записи</param>
|
||
<param name="subject">Предмет обсуждения записи (обязательный)</param>
|
||
<param name="content">Текст записи</param>
|
||
<returns>Обновленная запись</returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.SearchTopics(System.String)">
|
||
<summary>Возвращает список совпадающих с поисковым запросом тем с названием темы, датами создания и обновления, текстом записи и сведениями об авторе</summary>
|
||
<short>Найти</short>
|
||
<param name="query">Поисковой запрос</param>
|
||
<returns>список тем</returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.DeletePost(System.Int32)">
|
||
<summary>Удаляет выбранную запись</summary>
|
||
<short>Удалить запись</short>
|
||
<param name="postid">ИД записи</param>
|
||
<returns></returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.DeleteTopic(System.Int32)">
|
||
<summary>Удаляет выбранную тему</summary>
|
||
<short>Удалить тему</short>
|
||
<param name="topicid">ИД темы</param>
|
||
<returns></returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.DeleteThread(System.Int32)">
|
||
<summary>Удаляет выбранную ветку</summary>
|
||
<short>Удалить ветку</short>
|
||
<param name="threadid">ИД ветки</param>
|
||
<returns></returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.DeleteThreadCategory(System.Int32)">
|
||
<summary>Удаляет выбранную категорию веток</summary>
|
||
<short>Удалить категорию</short>
|
||
<param name="categoryid">ИД категории</param>
|
||
<returns></returns>
|
||
<category>Форумы</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.RemindAboutBirthday(System.Guid,System.Boolean)">
|
||
<summary>Подписаться на уведомления о дне рождения пользователя с указанным ИД или отписаться от них</summary>
|
||
<short>Подписаться на уведомления о дне рождения или отписаться от них </short>
|
||
<param name="userid">ИД пользователя</param>
|
||
<param name="onRemind">подписка должна быть оформлена или отменена</param>
|
||
<returns>значение onRemind</returns>
|
||
<category>День рождения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.CreatePage(System.String,System.String)">
|
||
<summary>Создает новую страницу wiki с указанными в запросе названием и контентом страницы</summary>
|
||
<short>Создать страницу</short>
|
||
<param name="name">Название страницы</param>
|
||
<param name="body">Контент страницы</param>
|
||
<returns>сведения о странице</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetPages(System.String)">
|
||
<summary>Возвращает список всех страниц в wiki или страниц в категории wiki, указанной в запросе</summary>
|
||
<short>Страницы</short>
|
||
<section>Страницы</section>
|
||
<param name="category">Название категории</param>
|
||
<returns></returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetPage(System.String,System.Nullable{System.Int32})">
|
||
<summary>Возвращает подробные сведения о странице wiki с указанными в запросе названием и версией</summary>
|
||
<short>Страница</short>
|
||
<section>Страницы</section>
|
||
<param name="name">Название страницы</param>
|
||
<param name="version">Версия страницы</param>
|
||
<returns>Сведения о странице</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetHistory(System.String)">
|
||
<summary>Возвращает список истории изменений для страницы wiki с указанным в запросе названием</summary>
|
||
<short>История</short>
|
||
<section>Страницы</section>
|
||
<param name="page">Название страницы</param>
|
||
<returns>Список страниц</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.SearchPages(System.String)">
|
||
<summary>Возвращает список страниц wiki с названием, которое совпадает с поисковым запросом, указанным в запросе</summary>
|
||
<short>Найти</short>
|
||
<section>Страницы</section>
|
||
<param name="name">Часть названия страницы</param>
|
||
<returns>Список страниц</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.SearchPagesByContent(System.String)">
|
||
<summary>Возвращает список страниц wiki с контентом, который совпадает с поисковым запросом, указанным в запросе</summary>
|
||
<short>Найти</short>
|
||
<section>Страницы</section>
|
||
<param name="content">Часть контента страницы</param>
|
||
<returns>Список страниц</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UpdatePage(System.String,System.String)">
|
||
<summary>Обновляет страницу wiki, заменяя ее название и контент названием и контентом из запроса</summary>
|
||
<short>Обновить страницу</short>
|
||
<section>Страницы</section>
|
||
<param name="name">Название страницы</param>
|
||
<param name="body">Контент страницы</param>
|
||
<returns>Сведения о странице</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.DeletePage(System.String)">
|
||
<summary>Удаляет страницу wiki, название которой указано в запросе</summary>
|
||
<short>Удалить страницу</short>
|
||
<section>Страницы</section>
|
||
<param name="name">Название страницы</param>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.CreateComment(System.String,System.String,System.String)">
|
||
<summary>Создает комментарий к выбранной странице wiki с указанным в запросе контентом</summary>
|
||
<short>Создать комментарий</short>
|
||
<section>Комментарии</section>
|
||
<param name="page">Название страницы</param>
|
||
<param name="content">Контент комментария</param>
|
||
<param name="parentId">ИД родительского комментария</param>
|
||
<returns>Сведения о комментарии</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetComments(System.String)">
|
||
<summary>Возвращает список всех комментариев к странице wiki с указанным в запросе названием</summary>
|
||
<short>Все комментарии</short>
|
||
<section>Комментарии</section>
|
||
<param name="page">Название страницы</param>
|
||
<returns>Список комментариев</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UploadFiles(System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
|
||
<summary>Загружает выбранные файлы в раздел wiki "Файлы"</summary>
|
||
<short>Загрузить файлы</short>
|
||
<param name="files">Список загружаемых файлов</param>
|
||
<returns>Список файлов</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetFile(System.String)">
|
||
<summary>Возвращает подробные сведения о файле с указанным именем в разделе wiki "Файлы"</summary>
|
||
<short>Файл</short>
|
||
<section>Файлы</section>
|
||
<param name="name">Название файла</param>
|
||
<returns>Сведения о файле</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.DeleteFile(System.String)">
|
||
<summary>Удаляет файлы с указанным именем из раздела wiki "Файлы"</summary>
|
||
<short>Удалить файл</short>
|
||
<param name="name">Название файла</param>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.GetWikiCommentPreview(System.String,System.String)">
|
||
<summary>Получить предварительный просмотр комментария с контентом, указанным в запросе</summary>
|
||
<short>Получить предварительный просмотр комментария</short>
|
||
<section>Комментарии</section>
|
||
<param name="commentid">ИД комментария</param>
|
||
<param name="htmltext">Контент комментария</param>
|
||
<returns>Сведения о комментарии</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.RemoveWikiComment(System.String)">
|
||
<summary>Удалить комментарий с указанным в запросе ИД</summary>
|
||
<short>Удалить комментарий</short>
|
||
<section>Комментарии</section>
|
||
<param name="commentid">ИД комментария</param>
|
||
<returns>Сведения о комментарии</returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.AddWikiComment(System.String,System.String,System.String)">
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Community.CommunityApi.UpdateWikiComment(System.String,System.String)">
|
||
<summary>Обновляет комментарий к выбранной странице wiki, добавляя указанный в запросе контент комментария</summary>
|
||
<short>Обновить комментарий</short>
|
||
<section>Комментарии</section>
|
||
<param name="commentid">ИД комментария</param>
|
||
<param name="content">Контент комментария</param>
|
||
<returns></returns>
|
||
<category>Wiki</category>
|
||
</member>
|
||
<member name="P:ASC.Api.Community.CommunityApi.Name">
|
||
<summary>Название начальной точки входа</summary>
|
||
</member>
|
||
</members>
|
||
</doc> |