r7: portals v10

This commit is contained in:
Sergey Linnik 2019-02-14 15:43:24 +03:00
parent 63ccb10304
commit a7d2f6504a
44 changed files with 788 additions and 385 deletions

View File

@ -4,6 +4,7 @@ using System.Linq;
using System.Text.RegularExpressions;
using ASC.Api.Interfaces;
using ASC.Common.DependencyInjection;
using ASC.Common.Logging;
using Autofac;
public static class Documentation
@ -19,6 +20,11 @@ public static class Documentation
private static List<MsDocEntryPoint> GenerateDocs()
{
var containerBuilder = AutofacConfigLoader.Load("api");
containerBuilder.Register(c => LogManager.GetLogger("ASC"))
.As<ILog>()
.SingleInstance();
containerBuilder.Register(c => c.Resolve<IApiRouteConfigurator>().RegisterEntryPoints())
.As<IEnumerable<IApiMethodCall>>()
.SingleInstance();

View File

@ -1397,15 +1397,6 @@
<category>Contacts</category>
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.FindFacebookProfiles(System.String,System.Boolean)">
<summary>
</summary>
<param name="searchText"></param>
<param name="isUser"></param>
<category>Contacts</category>
<returns></returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteContactAvatar(System.Int32,System.String,System.Boolean)">
<summary>
@ -1889,12 +1880,13 @@
Participant
</returns>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetDealsByPrefix(System.String,System.Int32)">
<member name="M:ASC.Api.CRM.CRMApi.GetDealsByPrefix(System.String,System.Int32,System.Boolean)">
<summary>
Returns the list of 30 opportunities in the CRM module with prefix
</summary>
<param optional="true" name="prefix"></param>
<param optional="true" name="contactID"></param>
<param optional="true" name="internalSearch"></param>
<category>Opportunities</category>
<returns>
Opportunities list
@ -2852,17 +2844,18 @@
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateTaskTemplateContainer(System.String,System.String)">
<summary>
Creates a new task template container with the type and title specified in the request
</summary>
<param name="entityType">Type</param>
<param name="title">Title</param>
<short>Create task template container</short>
<category>Task Templates</category>
<returns>
Task template container
</returns>
<summary>
Creates a new task template container with the type and title specified in the request
</summary>
<param name="entityType">Type</param>
<param name="title">Title</param>
<short>Create task template container</short>
<category>Task Templates</category>
<returns>
Task template container
</returns>
<exception cref="T:System.ArgumentException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskTemplateContainers(System.String)">
<summary>
@ -2874,59 +2867,64 @@
<returns>
Task template container list
</returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteTaskTemplateContainer(System.Int32)">
<summary>
Deletes the task template container with the ID specified in the request
</summary>
<param name="containerid">Task template container ID</param>
<short>Delete task template container</short>
<category>Task Templates</category>
<returns>
Deleted task template container
</returns>
<summary>
Deletes the task template container with the ID specified in the request
</summary>
<param name="containerid">Task template container ID</param>
<short>Delete task template container</short>
<category>Task Templates</category>
<returns>
Deleted task template container
</returns>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateTaskTemplateContainer(System.Int32,System.String)">
<summary>
Updates the task template container with the ID specified in the request
</summary>
<param name="containerid">Task template container ID</param>
<param name="title">Title</param>
<short>Update task template container</short>
<category>Task Templates</category>
<returns>
Task template container
</returns>
<summary>
Updates the task template container with the ID specified in the request
</summary>
<param name="containerid">Task template container ID</param>
<param name="title">Title</param>
<short>Update task template container</short>
<category>Task Templates</category>
<returns>
Task template container
</returns>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskTemplateContainerByID(System.Int32)">
<summary>
Returns the detailed information on the task template container with the ID specified in the request
</summary>
<param name="containerid">Task template container ID</param>
<short>Get task template container by ID</short>
<category>Task Templates</category>
<returns>
Task template container
</returns>
<summary>
Returns the detailed information on the task template container with the ID specified in the request
</summary>
<param name="containerid">Task template container ID</param>
<short>Get task template container by ID</short>
<category>Task Templates</category>
<returns>
Task template container
</returns>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskTemplates(System.Int32)">
<summary>
Returns the list of all tasks in the container with the ID specified in the request
</summary>
<param name="containerid">Task template container ID</param>
<short>Get task template list by contaier ID</short>
<category>Task Templates</category>
<returns>
Task template list
</returns>
<summary>
Returns the list of all tasks in the container with the ID specified in the request
</summary>
<param name="containerid">Task template container ID</param>
<short>Get task template list by contaier ID</short>
<category>Task Templates</category>
<returns>
Task template list
</returns>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CreateTaskTemplate(System.Int32,System.String,System.String,System.Guid,System.Int32,System.Boolean,System.Int64,System.Boolean)">
<summary>
@ -2945,6 +2943,7 @@
<returns>Task template</returns>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateTaskTemplate(System.Int32,System.Int32,System.String,System.String,System.Guid,System.Int32,System.Boolean,System.Int64,System.Boolean)">
<summary>
@ -2964,6 +2963,7 @@
<returns>Task template</returns>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.DeleteTaskTemplate(System.Int32)">
<summary>
@ -2975,6 +2975,7 @@
<returns>Task template</returns>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetTaskTemplateByID(System.Int32)">
<summary>
@ -2986,6 +2987,7 @@
<returns>Task template</returns>
<exception cref="T:System.ArgumentException"></exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetAvaliableCurrency">
<summary>
@ -3078,14 +3080,18 @@
<returns>Organisation company name</returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateOrganisationSettingsCompanyAddress(System.String)">
<member name="M:ASC.Api.CRM.CRMApi.UpdateOrganisationSettingsCompanyAddress(System.String,System.String,System.String,System.String,System.String)">
<summary>
Save organisation company address
</summary>
<param name="companyAddress">Organisation company address</param>
<param name="street">Organisation company street/building/apartment address</param>
<param name="city">City</param>
<param name="state">State</param>
<param name="zip">Zip</param>
<param name="country">Country</param>
<short>Save organisation company address</short>
<category>Organisation</category>
<returns>Organisation company address</returns>
<returns>Returns a JSON object with the organization company address details</returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.UpdateOrganisationSettingsLogo(System.Boolean)">
@ -3129,26 +3135,6 @@
<exception cref="T:System.Security.SecurityException"></exception>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SaveSMTPSettings(System.String,System.Int32,System.Boolean,System.String,System.String,System.String,System.String,System.Boolean)">
<summary>
Save SMTP Server Settings
</summary>
<short>Save SMTP Settings</short>
<param name="host">Host name</param>
<param name="port">Port</param>
<param name="authentication">Need authentication</param>
<param name="hostLogin">Host Login</param>
<param name="hostPassword">Host Password</param>
<param name="senderDisplayName">Sender Name</param>
<param name="senderEmailAddress">Sender Email Address</param>
<param name="enableSSL">Enable SSL</param>
<category>Common</category>
<returns>SMTP Server Settings</returns>
<exception cref="T:System.Security.SecurityException"></exception>
</member>
<member name="M:ASC.Api.CRM.CRMApi.SendTestMailSMTP(System.String,System.String,System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.StartImportFromCSV(System.String,System.String,System.String)">
<visible>false</visible>
</member>
@ -3161,13 +3147,22 @@
<member name="M:ASC.Api.CRM.CRMApi.ProcessUploadFake(System.String,System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetExportToCSVStatus">
<member name="M:ASC.Api.CRM.CRMApi.GetExportStatus">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.Cancel">
<member name="M:ASC.Api.CRM.CRMApi.CancelExport">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.StartExportData">
<member name="M:ASC.Api.CRM.CRMApi.StartExport">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetPartialExportStatus">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.CancelPartialExport">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.StartPartialExport(System.String,System.String)">
<visible>false</visible>
</member>
<member name="M:ASC.Api.CRM.CRMApi.GetAvailablePhoneNumbers(ASC.VoipService.Twilio.PhoneNumberType,System.String)">

View File

@ -10,6 +10,9 @@
<member name="P:ASC.Api.Calendar.BusinessObjects.Calendar.ObjectType">
<inheritdoc/>
</member>
<member name="P:ASC.Api.Calendar.BusinessObjects.Todo.ObjectType">
<inheritdoc/>
</member>
<member name="P:ASC.Api.Calendar.BusinessObjects.Event.ObjectType">
<inheritdoc/>
</member>
@ -71,7 +74,7 @@
<param name="calendarId">Calendar ID</param>
<returns>Calendar</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.CreateCalendar(System.String,System.String,System.String,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam})">
<member name="M:ASC.Api.Calendar.CalendarApi.CreateCalendar(System.String,System.String,System.String,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},System.String,System.Int32)">
<summary>
Creates the new calendar with the parameters (name, description, color, etc.) specified in the request
</summary>
@ -85,9 +88,11 @@
<param name="timeZone">Calendar time zone</param>
<param name="alertType">Event alert type, in case alert type is set by default</param>
<param name="sharingOptions">Calendar sharing options with other users</param>
<param name="iCalUrl">iCal url</param>
<param name="isTodo">Calendar for todo list</param>
<returns>Created calendar</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.UpdateCalendar(System.String,System.String,System.String,System.String,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam})">
<member name="M:ASC.Api.Calendar.CalendarApi.UpdateCalendar(System.String,System.String,System.String,System.String,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},System.String)">
<summary>
Updates the selected calendar with the parameters (name, description, color, etc.) specified in the request for the current user and access rights for other users
</summary>
@ -103,6 +108,7 @@
<param name="alertType">Event alert type, in case alert type is set by default</param>
<param name="hideEvents">Display type: show or hide events in calendar</param>
<param name="sharingOptions">Calendar sharing options with other users</param>
<param name="iCalUrl">iCal url</param>
<returns>Updated calendar</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.UpdateCalendarView(System.String,System.String,System.String,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean)">
@ -140,6 +146,38 @@
<param name="calendarId">Calendar ID</param>
<returns>iCal link</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendarCalDavUrl(System.String)">
<summary>
Returns the link for the CalDav associated with the calendar with the ID specified in the request
</summary>
<short>
Get CalDav link
</short>
<param name="calendarId">Calendar ID</param>
<returns>CalDav link</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.ChangeOfCalendarStorage(System.String,System.String)">
<summary>
Run caldav event update function
</summary>
<short>
Update CalDav Event
</short>
<param name="change">changes of event</param>
<param name="key"></param>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.CaldavDeleteEvent(System.String,System.String)">
<summary>
Run caldav event delete function
</summary>
<short>
Delete CalDav Event
</short>
<param name="eventInfo">event info</param>
<param name="key"></param>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendariCalStream(System.String,System.String)">
<summary>
Returns the feed for the iCal associated with the calendar by its ID and signagure specified in the request
@ -250,7 +288,28 @@
<param name="status">Event status</param>
<returns>Updated event list</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.AddEvent(System.Int32,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam})">
<member name="M:ASC.Api.Calendar.CalendarApi.AddTodo(System.String,System.String)">
<summary>
Creates the new task in the selected calendar with the parameters specified in the request
</summary>
<short>
Create new event
</short>
<param name="ics">Task in iCal format</param>
<param name="todoUid">Task uid</param>
<returns>Todo</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveTodo(System.Int32,System.Boolean)">
<summary>
Deletes task
</summary>
<short>
Delete task
</short>
<param name="todoId">Task ID</param>
<param name="fromCaldavServer">Bool flag says that request from caldav server</param>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.AddEvent(System.Int32,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},System.String)">
<summary>
Creates the new event in the selected calendar with the parameters specified in the request
</summary>
@ -261,9 +320,10 @@
<param name="ics">Event in iCal format</param>
<param name="alertType">Event notification type</param>
<param name="sharingOptions">Event sharing access parameters</param>
<param name="eventUid">Event uid</param>
<returns>Event</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.UpdateEvent(System.Int32,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam})">
<member name="M:ASC.Api.Calendar.CalendarApi.UpdateEvent(System.Int32,System.String,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},System.Boolean,System.String)">
<summary>
Updates the existing event in the selected calendar with the parameters specified in the request
</summary>
@ -275,6 +335,8 @@
<param name="ics">Event in iCal format</param>
<param name="alertType">Event notification type</param>
<param name="sharingOptions">Event sharing access parameters</param>
<param name="fromCalDavServer">bool flag says that request from caldav server</param>
<param name="ownerId">Event owner id</param>
<returns>Updated event</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveEvent(System.Int32)">
@ -286,7 +348,7 @@
</short>
<param name="eventId">Event ID</param>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveEvent(System.Int32,ASC.Specific.ApiDateTime,ASC.Api.Calendar.CalendarApi.EventRemoveType)">
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveEvent(System.Int32,ASC.Specific.ApiDateTime,ASC.Api.Calendar.CalendarApi.EventRemoveType,System.Boolean)">
<summary>
Deletes one event from the series of recurrent events
</summary>
@ -296,6 +358,7 @@
<param name="eventId">Event ID</param>
<param name="date">Date to be deleted from the recurrent event</param>
<param name="type">Recurrent event deletion type</param>
<param name="fromCaldavServer">Bool flag says that request from caldav server</param>
<returns>Updated event series collection</returns>
</member>
<member name="M:ASC.Api.Calendar.CalendarApi.UnsubscribeEvent(System.Int32)">

View File

@ -422,6 +422,23 @@
<member name="M:ASC.Api.Community.CommunityApi.UpdateBookmarkComment(System.String,System.String)">
<category>Bookmarks</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.RemoveBookmarkFromFavourite(System.Int64)">
<summary>
Removes bookmark from favourite. If after removing user bookmark raiting of this bookmark is 0, the bookmark will be removed completely.
</summary>
<short>Removes bookmark from favourite</short>
<param name="id">Bookmark ID</param>
<returns>bookmark</returns>
<category>Bookmarks</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.RemoveBookmark(System.Int64)">
<summary>
Removes bookmark
</summary>
<short>Removes bookmark</short>
<param name="id">Bookmark ID</param>
<category>Bookmarks</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.GetEvents">
<summary>
Returns the list of all events on the portal with the event titles, date of creation and update, event text and author
@ -720,18 +737,6 @@
<returns>Updated post</returns>
<category>Forums</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.DeleteTopicPosts(System.Int32,System.Int32)">
<summary>
Deletes a selected post in an existing topic
</summary>
<short>
Delete post in topic
</short>
<param name="topicid">Topic ID</param>
<param name="postid">Post ID</param>
<returns></returns>
<category>Forums</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.SearchTopics(System.String)">
<summary>
Returns a list of topics matching the search query with the topic title, date of creation and update, post text and author
@ -743,6 +748,50 @@
<returns>list of topics</returns>
<category>Forums</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.DeletePost(System.Int32)">
<summary>
Deletes a selected post
</summary>
<short>
Delete post
</short>
<param name="postid">Post ID</param>
<returns></returns>
<category>Forums</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.DeleteTopic(System.Int32)">
<summary>
Deletes a selected topic
</summary>
<short>
Delete topic
</short>
<param name="topicid">Topic ID</param>
<returns></returns>
<category>Forums</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.DeleteThread(System.Int32)">
<summary>
Deletes a selected thread
</summary>
<short>
Delete thread
</short>
<param name="threadid">Thread ID</param>
<returns></returns>
<category>Forums</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.DeleteThreadCategory(System.Int32)">
<summary>
Deletes a selected thread category
</summary>
<short>
Delete category
</short>
<param name="categoryid">Category ID</param>
<returns></returns>
<category>Forums</category>
</member>
<member name="M:ASC.Api.Community.CommunityApi.RemindAboutBirthday(System.Guid,System.Boolean)">
<summary>
Subscribe or unsubscribe on birthday of user with the ID specified

View File

@ -4,6 +4,18 @@
<name>ASC.Api.Documents</name>
</assembly>
<members>
<member name="M:ASC.Api.Documents.BlockchainApi.UpdateData(System.String,System.String)">
<summary>
</summary>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Documents.BlockchainApi.GetAccessAddresses(System.String)">
<summary>
</summary>
<visible>false</visible>
</member>
<member name="T:ASC.Api.Documents.DocumentsApi">
<summary>
Provides access to documents
@ -118,7 +130,7 @@
<param name="files" visible="false">List of files when posted as multipart/form-data</param>
<returns>Uploaded file</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.UploadFile(System.String,System.IO.Stream,System.Net.Mime.ContentType,System.Net.Mime.ContentDisposition,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase},System.Boolean,System.Boolean,System.Boolean)">
<member name="M:ASC.Api.Documents.DocumentsApi.UploadFile(System.String,System.IO.Stream,System.Net.Mime.ContentType,System.Net.Mime.ContentDisposition,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase},System.Nullable{System.Boolean},System.Boolean,System.Boolean)">
<summary>
Uploads the file specified with single file upload or standart multipart/form-data method to the selected folder
</summary>
@ -142,7 +154,7 @@
<param name="keepConvertStatus" visible="false">Keep status conversation after finishing</param>
<returns>Uploaded file</returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFileToMy(System.IO.Stream,System.String,System.Boolean,System.Boolean)">
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFileToMy(System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Boolean)">
<summary>
Uploads the file specified with single file upload to 'Common Documents' section
</summary>
@ -153,7 +165,7 @@
<category>Uploads</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFileToCommon(System.IO.Stream,System.String,System.Boolean,System.Boolean)">
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFileToCommon(System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Boolean)">
<summary>
Uploads the file specified with single file upload to 'Common Documents' section
</summary>
@ -164,7 +176,7 @@
<category>Uploads</category>
<returns></returns>
</member>
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFile(System.String,System.IO.Stream,System.String,System.Boolean,System.Boolean)">
<member name="M:ASC.Api.Documents.DocumentsApi.InsertFile(System.String,System.IO.Stream,System.String,System.Nullable{System.Boolean},System.Boolean)">
<summary>
Uploads the file specified with single file upload
</summary>
@ -949,6 +961,10 @@
<summary>
</summary>
</member>
<member name="P:ASC.Api.Documents.FileWrapper.Encrypted">
<summary>
</summary>
</member>
<member name="T:ASC.Api.Documents.FolderContentWrapper">
<summary>
</summary>

View File

@ -79,7 +79,18 @@
<param name="query">Search text</param>
<returns>User list</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetByFilter(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})">
<member name="M:ASC.Api.Employee.EmployeeApi.SaveUsers(System.String,System.Boolean)">
<summary>
Adds a new portal user from import with the first and last name, email address
</summary>
<short>
Add new import user
</short>
<param name="userList">The list of users to add</param>
<param name="importUsersAsCollaborators" optional="true">Add users as guests (bool type: false|true)</param>
<returns>Newly created users</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>
Returns the list of users matching the filter with the parameters specified in the request
</summary>
@ -95,7 +106,23 @@
User list
</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)">
<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>
Returns the list of users matching the filter with the parameters specified in the request
</summary>
<short>
User search by extended filter
</short>
<param optional="true" name="employeeStatus">User status</param>
<param optional="true" name="groupId">Group ID</param>
<param optional="true" name="activationStatus">Activation status</param>
<param optional="true" name="employeeType">User type</param>
<param optional="true" name="isAdministrator">Administrator(bool type)</param>
<returns>
User list
</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>
Adds a new portal user with the first and last name, email address and several optional parameters specified in the request
</summary>
@ -115,6 +142,7 @@
<param name="comment" optional="true">Comment for user</param>
<param name="contacts">List of contacts</param>
<param name="files">Avatar photo url</param>
<param name="password" optional="true">User Password</param>
<returns>Newly created user</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)">
@ -207,6 +235,16 @@
<param name="contacts">Contacts list</param>
<returns>Updated user profile</returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.GetMemberPhoto(System.String)">
<summary>
Get user photoes
</summary>
<short>
Get user photoes
</short>
<param name="userid">User ID</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMemberPhoto(System.String,System.String)">
<summary>
Updates the specified user photo with the pathname
@ -228,6 +266,21 @@
<param name="userid">User ID</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>
Create photo thumbnails by coordinates of original image
</summary>
<short>
Create user photo thumbnails
</short>
<param name="userid">User ID</param>
<param name="tmpFile">Path to the temporary file</param>
<param name="x">X</param>
<param name="y">Y</param>
<param name="width">Width</param>
<param name="height">Height</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.SendUserPassword(System.String)">
<summary>
Remind password for the user with email specified in the request
@ -342,12 +395,13 @@
<param name="userId">User ID whose data is reassigned</param>
<category>Reassign user data</category>
</member>
<member name="M:ASC.Api.Employee.EmployeeApi.StartReassign(System.Guid,System.Guid)">
<member name="M:ASC.Api.Employee.EmployeeApi.StartReassign(System.Guid,System.Guid,System.Boolean)">
<summary>
Start a reassign process
</summary>
<param name="fromUserId">From User ID</param>
<param name="toUserId">To User ID</param>
<param name="deleteProfile">Delete profile when reassignment will be finished</param>
<category>Reassign user data</category>
<returns>Reassign Progress</returns>
</member>

View File

@ -4,6 +4,66 @@
<name>ASC.Api.Mail</name>
</assembly>
<members>
<member name="M:ASC.Api.Mail.MailApi.GetFilters">
<summary>
Returns list of the tags used in Mail
</summary>
<returns>Filters list. Filters represented as JSON.</returns>
<short>Get filters list</short>
<category>Filters</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.CreateFilter(ASC.Mail.Data.Contracts.MailSieveFilterData)">
<summary>
Creates a new filter
</summary>
<param name="filter"></param>
<returns>Filter</returns>
<short>Create filter</short>
<category>Filters</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.UpdateFilter(ASC.Mail.Data.Contracts.MailSieveFilterData)">
<summary>
Updates the selected filter
</summary>
<param name="filter"></param>
<returns>Updated filter</returns>
<short>Update filter</short>
<category>Filters</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.DeleteFilter(System.Int32)">
<summary>
Deletes the selected filter
</summary>
<param name="id">Filter id</param>
<returns>Deleted Filter id</returns>
<short>Delete filter</short>
<category>Filters</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.CheckFilter(ASC.Mail.Data.Contracts.MailSieveFilterData,System.Nullable{System.Int32},System.Nullable{System.Int32})">
<summary>
Check filter result
</summary>
<param name="filter"></param>
<param optional="true" name="page">Page number</param>
<param optional="true" name="pageSize">Number of messages on page</param>
<returns>List messages</returns>
<short>Check filter</short>
<category>Filters</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.ApplyFilter(System.Int32)">
<summary>
Apply filter to existing messages
</summary>
<param name="id">Filter id</param>
<returns>MailOperationResult object</returns>
<short>Check filter</short>
<category>Filters</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetMailServerInfo">
<visible>false</visible>
</member>
@ -226,11 +286,12 @@
<category>Tests</category>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Mail.MailApi.LoadSampleMessage(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.IO.Stream)">
<member name="M:ASC.Api.Mail.MailApi.LoadSampleMessage(System.Nullable{System.Int32},System.Nullable{System.UInt32},System.Nullable{System.Int32},System.Boolean,System.IO.Stream)">
<summary>
Load sample message from EML [Tests]
</summary>
<param name="folderId"></param>
<param name="userFolderId"></param>
<param name="mailboxId"></param>
<param name="unread"></param>
<param name="emlStream"></param>
@ -247,6 +308,17 @@
<short>Get mailboxes, aliases and groups list</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetAccount(System.String)">
<summary>
Returns the information about the account.
</summary>
<param name="email">Account email address</param>
<returns>Account with specified email</returns>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
<exception cref="T:System.NullReferenceException">Exception happens when mailbox wasn't found by email.</exception>
<short>Get account by email</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.CreateAccountSimple(System.String,System.String)">
<summary>
Creates an account based on email and password.
@ -259,30 +331,7 @@
<short>Create new account by email and password</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.CreateAccountOAuth(System.String,System.Byte)">
<summary>
Creates Mail account with OAuth authentication. Only Google OAuth supported.
</summary>
<param name="code">Oauth code</param>
<param name="type">Type of OAuth service. 0- Unknown, 1 - Google.</param>
<exception cref="T:System.Exception">Exception contains text description of happened error.</exception>
<returns>Created account</returns>
<short>Create OAuth account</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.UpdateAccountOAuth(System.String,System.Byte,System.Int32)">
<summary>
Update Mail account with OAuth authentication. Only Google OAuth supported.
</summary>
<param name="code">Oauth code</param>
<param name="type">Type of OAuth service. 0- Unknown, 1 - Google.</param>
<param name="mailboxId">Mailbox ID to update</param>
<exception cref="T:System.Exception">Exception contains text description of happened error.</exception>
<returns>Updated OAuth account</returns>
<short>Update OAuth account</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.CreateAccount(System.String,System.String,System.String,System.String,System.Int32,System.String,System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean,System.Boolean,ASC.Mail.Aggregator.Common.EncryptionType,ASC.Mail.Aggregator.Common.EncryptionType,ASC.Mail.Aggregator.Common.SaslMechanism,ASC.Mail.Aggregator.Common.SaslMechanism)">
<member name="M:ASC.Api.Mail.MailApi.CreateAccount(System.String,System.String,System.String,System.String,System.Int32,System.String,System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean,System.Boolean,ASC.Mail.Enums.EncryptionType,ASC.Mail.Enums.EncryptionType,ASC.Mail.Enums.SaslMechanism,ASC.Mail.Enums.SaslMechanism)">
<summary>
Creates account using full information about mail servers.
</summary>
@ -308,7 +357,30 @@
<short>Create account with custom mail servers.</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.UpdateAccount(System.String,System.String,System.String,System.String,System.Int32,System.String,System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean,ASC.Mail.Aggregator.Common.EncryptionType,ASC.Mail.Aggregator.Common.EncryptionType,ASC.Mail.Aggregator.Common.SaslMechanism,ASC.Mail.Aggregator.Common.SaslMechanism)">
<member name="M:ASC.Api.Mail.MailApi.CreateAccountOAuth(System.String,System.Byte)">
<summary>
Creates Mail account with OAuth authentication. Only Google OAuth supported.
</summary>
<param name="code">Oauth code</param>
<param name="type">Type of OAuth service. 0- Unknown, 1 - Google.</param>
<exception cref="T:System.Exception">Exception contains text description of happened error.</exception>
<returns>Created account</returns>
<short>Create OAuth account</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.UpdateAccountOAuth(System.String,System.Byte,System.Int32)">
<summary>
Update Mail account with OAuth authentication. Only Google OAuth supported.
</summary>
<param name="code">Oauth code</param>
<param name="type">Type of OAuth service. 0- Unknown, 1 - Google.</param>
<param name="mailboxId">Mailbox ID to update</param>
<exception cref="T:System.Exception">Exception contains text description of happened error.</exception>
<returns>Updated OAuth account</returns>
<short>Update OAuth account</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.UpdateAccount(System.String,System.String,System.String,System.String,System.Int32,System.String,System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean,ASC.Mail.Enums.EncryptionType,ASC.Mail.Enums.EncryptionType,ASC.Mail.Enums.SaslMechanism,ASC.Mail.Enums.SaslMechanism)">
<summary>
Updates the existing account.
</summary>
@ -368,18 +440,7 @@
<short>Set default account</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetAccount(System.String)">
<summary>
Returns the information about the account.
</summary>
<param name="email">Account email address</param>
<returns>Account with specified email</returns>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
<exception cref="T:System.NullReferenceException">Exception happens when mailbox wasn't founded by email.</exception>
<short>Get account by email</short>
<category>Accounts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetAccountsDefaults(System.String,System.String)">
<member name="M:ASC.Api.Mail.MailApi.GetAccountDefaults(System.String,System.String)">
<summary>
Gets the default settings for the account based on the email domain.
</summary>
@ -453,7 +514,7 @@
<short>Gets filtered contacts</short>
<category>Contacts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetContactsByContactInfo(ASC.Mail.Aggregator.ContactInfoType,System.String,System.Nullable{System.Boolean})">
<member name="M:ASC.Api.Mail.MailApi.GetContactsByContactInfo(ASC.Mail.Enums.ContactInfoType,System.String,System.Nullable{System.Boolean})">
<summary>
Returns lists of mail contacts with contact information
</summary>
@ -476,7 +537,7 @@
<short>Create mail contact</short>
<category>Contacts</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.RemoveContact(System.Collections.Generic.List{System.Int32})">
<member name="M:ASC.Api.Mail.MailApi.RemoveContacts(System.Collections.Generic.List{System.Int32})">
<summary>
Removes selected mail contacts
</summary>
@ -508,7 +569,7 @@
<category>Contacts</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetFilteredConversations(System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.String,ASC.Specific.ApiDateTime,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
<member name="M:ASC.Api.Mail.MailApi.GetFilteredConversations(System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.String,ASC.Specific.ApiDateTime,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32})">
<summary>
Returns filtered conversations, if were changes since last check date
</summary>
@ -518,7 +579,8 @@
<param optional="true" name="period_from">Begin search period date</param>
<param optional="true" name="period_to">End search period date</param>
<param optional="true" name="important">Message has importance flag. bool flag.</param>
<param optional="true" name="find_address">Address to find. Email for search in all mail fields: from, to</param>
<param optional="true" name="from_address">Address to find 'From' field</param>
<param optional="true" name="to_address">Address to find 'To' field</param>
<param optional="true" name="mailbox_id">Recipient mailbox id.</param>
<param optional="true" name="tags">Messages tags. Id of tags linked with target messages.</param>
<param optional="true" name="search">Text to search in messages body and subject.</param>
@ -527,6 +589,7 @@
<param optional="true" name="from_date">Date from wich conversations search performed</param>
<param optional="true" name="from_message">Message from wich conversations search performed</param>
<param optional="true" name="with_calendar">Message has calendar flag. bool flag.</param>
<param optional="true" name="user_folder_id">id of user's folder</param>
<param name="prev_flag"></param>
<returns>List of filtered chains</returns>
<short>Gets filtered conversations</short>
@ -544,7 +607,7 @@
<category>Conversations</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetPrevNextConversationId(System.Int32,System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean})">
<member name="M:ASC.Api.Mail.MailApi.GetPrevNextConversationId(System.Int32,System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.Nullable{System.Int32})">
<summary>
Get previous or next conversation id.
</summary>
@ -556,22 +619,25 @@
<param optional="true" name="period_from">Begin search period date</param>
<param optional="true" name="period_to">End search period date</param>
<param optional="true" name="important">Message has importance flag. bool flag.</param>
<param optional="true" name="find_address">Address to find. Email for search in all mail fields: from, to</param>
<param optional="true" name="from_address">Address to find 'From' field</param>
<param optional="true" name="to_address">Address to find 'To' field</param>
<param optional="true" name="mailbox_id">Recipient mailbox id.</param>
<param optional="true" name="tags">Messages tags. Id of tags linked with target messages.</param>
<param optional="true" name="search">Text to search in messages body and subject.</param>
<param optional="true" name="page_size">Count on messages on page</param>
<param name="sortorder">Sort order by date. String parameter: "ascending" - ascended, "descending" - descended.</param>
<param optional="true" name="with_calendar">Message has with_calendar flag. bool flag.</param>
<param optional="true" name="user_folder_id">id of user's folder</param>
<returns>Head message id of previous or next conversation.</returns>
<category>Conversations</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.MoveConversations(System.Collections.Generic.List{System.Int32},System.Int32)">
<member name="M:ASC.Api.Mail.MailApi.MoveConversations(System.Collections.Generic.List{System.Int32},System.Int32,System.Nullable{System.UInt32})">
<summary>
Moves conversation specified in ids to the folder.
</summary>
<param name="ids">List of mesasges ids from conversations.</param>
<param name="folder">Folder ID - integer. 1 - inbox, 2 - sent, 3 - drafts, 4 - trash, 5 - spam.</param>
<param optional="true" name="userFolderId">User Folder Id</param>
<returns>List of mesasges ids from conversations.</returns>
<short>Move conversations to folder</short>
<category>Conversations</category>
@ -627,7 +693,7 @@
<category>Conversations</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.LinkConversationToCrm(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Aggregator.Common.CrmContactEntity})">
<member name="M:ASC.Api.Mail.MailApi.LinkConversationToCrm(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Data.Contracts.CrmContactData})">
<summary>
Marks conversation as CRM linked. All new mail will be added to CRM history.
</summary>
@ -639,7 +705,7 @@
<category>Conversations</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.MarkConversationAsCrmLinked(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Aggregator.Common.CrmContactEntity})">
<member name="M:ASC.Api.Mail.MailApi.MarkConversationAsCrmLinked(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Data.Contracts.CrmContactData})">
<summary>
Marks conversation as CRM linked. All new mail will be added to CRM history.
</summary>
@ -651,7 +717,7 @@
<category>Conversations</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.UnmarkConversationAsCrmLinked(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Aggregator.Common.CrmContactEntity})">
<member name="M:ASC.Api.Mail.MailApi.UnmarkConversationAsCrmLinked(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Data.Contracts.CrmContactData})">
<summary>
Method tears conversation link with crm.
</summary>
@ -674,7 +740,7 @@
</member>
<member name="M:ASC.Api.Mail.MailApi.GetFolders">
<summary>
Returns the list of all folders
Returns the list of default folders
</summary>
<returns>Folders list</returns>
<short>Get folders</short>
@ -690,13 +756,65 @@
</member>
<member name="M:ASC.Api.Mail.MailApi.RecalculateFolders">
<summary>
Returns the list of all folders
Recalculate folders counters
</summary>
<returns>Folders list</returns>
<returns>MailOperationResult object</returns>
<short>Get folders</short>
<category>Folders</category>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetUserFolders(System.Collections.Generic.List{System.UInt32},System.Nullable{System.UInt32})">
<summary>
Returns the list of user folders
</summary>
<param name="ids" optional="true">List of folder's id</param>
<param name="parentId" optional="true">Selected parent folder id (root level equals 0)</param>
<returns>Folders list</returns>
<short>Get folders</short>
<category>Folders</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.CreateUserFolder(System.String,System.UInt32)">
<summary>
Create user folder
</summary>
<param name="name">Folder name</param>
<param name="parentId">Parent folder id (default = 0)</param>
<returns>Folders list</returns>
<short>Create folder</short>
<category>Folders</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.UpdateUserFolder(System.UInt32,System.String,System.Nullable{System.UInt32})">
<summary>
Update user folder
</summary>
<param name="id">Folder id</param>
<param name="name">new Folder name</param>
<param name="parentId">new Parent folder id (default = 0)</param>
<returns>Folders list</returns>
<short>Update folder</short>
<category>Folders</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.DeleteUserFolder(System.UInt32)">
<summary>
Delete user folder
</summary>
<param name="id">Folder id</param>
<short>Delete folder</short>
<category>Folders</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
<returns>MailOperationResult object</returns>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetUserFolderByMailId(System.UInt32)">
<summary>
Returns the user folders by mail id
</summary>
<param name="mailId">List of folder's id</param>
<returns>User Folder</returns>
<short>Get folder by mail id</short>
<category>Folders</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetDisplayImagesAddresses">
<summary>
Returns list of all trusted addresses for image displaying.
@ -725,7 +843,7 @@
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
<category>Images</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetFilteredMessages(System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean})">
<member name="M:ASC.Api.Mail.MailApi.GetFilteredMessages(System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.Nullable{System.Int32})">
<summary>
Returns the filtered messages in case there were changes since last check date
</summary>
@ -735,13 +853,15 @@
<param optional="true" name="period_from">Period start date</param>
<param optional="true" name="period_to">Period end date</param>
<param optional="true" name="important">Message with importance flag</param>
<param optional="true" name="find_address">Address to find</param>
<param optional="true" name="from_address">Address to find 'From' field</param>
<param optional="true" name="to_address">Address to find 'To' field</param>
<param optional="true" name="mailbox_id">Recipient mailbox id</param>
<param optional="true" name="tags">Message tags</param>
<param optional="true" name="search">Text to search in messages</param>
<param optional="true" name="page">Page number</param>
<param optional="true" name="with_calendar">Message has calendar flag. bool flag.</param>
<param optional="true" name="page_size">Number of messages on page</param>
<param optional="true" name="user_folder_id">id of user's folder</param>
<param name="sortorder">Sort order</param>
<returns>Messages list</returns>
<short>Get filtered messages</short>
@ -759,9 +879,9 @@
<short>Get message</short>
<category>Messages</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException">Exception happens when message with specified id wasn't founded.</exception>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException">Exception happens when message with specified id wasn't found.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.GetPrevNextMessageId(System.Int32,System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean})">
<member name="M:ASC.Api.Mail.MailApi.GetPrevNextMessageId(System.Int32,System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.Nullable{System.Int32})">
<summary>
Get previous or next message id. U
</summary>
@ -773,13 +893,15 @@
<param optional="true" name="period_from">Begin search period date</param>
<param optional="true" name="period_to">End search period date</param>
<param optional="true" name="important">Message has importance flag. bool flag.</param>
<param optional="true" name="find_address">Address to find. Email for search in all mail fields: from, to</param>
<param optional="true" name="from_address">Address to find 'From' field</param>
<param optional="true" name="to_address">Address to find 'To' field</param>
<param optional="true" name="mailbox_id">Recipient mailbox id.</param>
<param optional="true" name="tags">Messages tags. Id of tags linked with target messages.</param>
<param optional="true" name="search">Text to search in messages body and subject.</param>
<param optional="true" name="page_size">Count on messages on page</param>
<param optional="true" name="sortorder">Sort order by date. String parameter: "ascending" - ascended, "descending" - descended.</param>
<param optional="true" name="with_calendar">Message has with_calendar flag. bool flag.</param>
<param optional="true" name="user_folder_id">id of user's folder</param>
<returns>Previous or next message id</returns>
<short>Get previous or next message id</short>
<category>Messages</category>
@ -814,17 +936,18 @@
<short>Restore messages to original folders</short>
<category>Messages</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.MoveMessages(System.Collections.Generic.List{System.Int32},System.Int32)">
<member name="M:ASC.Api.Mail.MailApi.MoveMessages(System.Collections.Generic.List{System.Int32},System.Int32,System.Nullable{System.UInt32})">
<summary>
Moves the messages to the specified folder
</summary>
<param name="ids">List of mesasges ids.</param>
<param name="folder">Folder ID - integer. 1 - inbox, 2 - sent, 3 - drafts, 4 - trash, 5 - spam.</param>
<param optional="true" name="userFolderId">User Folder Id</param>
<returns>List of moved messages ids.</returns>
<short>Move message to folder</short>
<category>Messages</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.SendMessage(System.Int32,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.String,System.Boolean,System.String,System.Collections.Generic.List{System.Int32},System.String,System.Collections.Generic.List{ASC.Mail.Aggregator.Common.MailAttachment},ASC.Files.Core.Security.FileShare,System.String,System.Boolean)">
<member name="M:ASC.Api.Mail.MailApi.SendMessage(System.Int32,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.String,System.Boolean,System.String,System.Collections.Generic.List{System.Int32},System.String,System.Collections.Generic.List{ASC.Mail.Data.Contracts.MailAttachmentData},ASC.Files.Core.Security.FileShare,System.String,System.Boolean)">
<summary>
Sends the message with the ID specified in the request
</summary>
@ -846,7 +969,7 @@
<short>Send message</short>
<category>Messages</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.SaveMessage(System.Int32,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.String,System.Boolean,System.String,System.Collections.Generic.List{System.Int32},System.String,System.Collections.Generic.List{ASC.Mail.Aggregator.Common.MailAttachment},System.String)">
<member name="M:ASC.Api.Mail.MailApi.SaveMessage(System.Int32,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.String,System.Boolean,System.String,System.Collections.Generic.List{System.Int32},System.String,System.Collections.Generic.List{ASC.Mail.Data.Contracts.MailAttachmentData},System.String)">
<summary>
Saves the message with the ID specified in the request
</summary>
@ -883,20 +1006,19 @@
<short>Get message template</short>
<category>Messages</category>
</member>
<member name="M:ASC.Api.Mail.MailApi.AttachDocument(System.Int32,System.String,System.String,System.String)">
<summary>
Attaches Teamlab document to the specified message
</summary>
<param name="id"> Message id for adding attachment</param>
<member name="M:ASC.Api.Mail.MailApi.AttachDocument(System.Int32,System.String,System.String)">
<summary>
Attaches Teamlab document to the specified message
</summary>
<param name="id"> Message id for adding attachment</param>
<param name="fileId">Teamlab document id.</param>
<param name="version">Teamlab document version</param>
<param name="shareLink">Teamlab document share link</param>
<returns>Attached document as MailAttachment object</returns>
<short>Attach Teamlab document</short>
<category>Messages</category>
<exception cref="T:System.ArgumentException">Exception happens when in parameters is invalid. Text description contains parameter name and text description.</exception>
</member>
<member name="M:ASC.Api.Mail.MailApi.ExportMessageToCrm(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Aggregator.Common.CrmContactEntity})">
<member name="M:ASC.Api.Mail.MailApi.ExportMessageToCrm(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Data.Contracts.CrmContactData})">
<summary>
Export mail to CRM relations history for some entities
</summary>
@ -987,191 +1109,5 @@
Timeout in milliseconds
</summary>
</member>
<member name="P:ASC.Api.Mail.MailApi.NeedProxyHttp">
<summary>
Need any mail's body http links change to proxy handler
</summary>
</member>
<member name="P:ASC.Api.Mail.MailApi.SslCertificatesErrorPermit">
<summary>
Permit errors of SSL certificates
</summary>
</member>
<member name="P:ASC.Api.Mail.MailApi.ProtocolLogPath">
<summary>
Protocol log path (if not empty then enabled)
</summary>
</member>
<member name="P:ASC.Api.Mail.MailApi.TcpTimeout">
<summary>
Test mailbox connection tcp timeout (10 sec is default)
</summary>
</member>
<member name="T:ASC.Api.Mail.Resources.MailApiResource">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.AttachmentsBadInputParamsError">
<summary>
Looks up a localized string similar to Some input parameters are invalid..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.AttachmentsDocumentAccessDeniedError">
<summary>
Looks up a localized string similar to Access to the document is denied..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.AttachmentsDocumentNotFoundError">
<summary>
Looks up a localized string similar to Document could not be found or does not exist on the chosen storage..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.AttachmentsEmptyFileNotSupportedError">
<summary>
Looks up a localized string similar to Empty files are not supported..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.AttachmentsMessageNotFoundError">
<summary>
Looks up a localized string similar to Message could not be found..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.AttachmentsTotalLimitError">
<summary>
Looks up a localized string similar to Total size of all attachments exceeds limit..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.AttachmentsUnknownError">
<summary>
Looks up a localized string similar to Some unexpected error has occurred. Please try again later..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.DeliveryFailureAutomaticMessage">
<summary>
Looks up a localized string similar to This message was created automatically by mail delivery software..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.DeliveryFailureBtn">
<summary>
Looks up a localized string similar to Change your message.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.DeliveryFailureFAQInformation">
<summary>
Looks up a localized string similar to In case the error persists, please read the {url_begin}FAQ section{url_end} to learn more about the problem..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.DeliveryFailureHeaders">
<summary>
Looks up a localized string similar to Message headers follow.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.DeliveryFailureMessageIdentificator">
<summary>
Looks up a localized string similar to Delivery failed for message with subject &quot;{subject}&quot; from {date}..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.DeliveryFailureReason">
<summary>
Looks up a localized string similar to Reason.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.DeliveryFailureRecipients">
<summary>
Looks up a localized string similar to Message could not be delivered to recipient(s).
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.DeliveryFailureRecommendations">
<summary>
Looks up a localized string similar to Please, check your message recipients addresses and message format. If you are sure your message is correct, check all the {account_name} account settings, and, if everything is correct, sign in to the mail service you use and confirm any verification questions, in case there are some. After then try again..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.DeliveryFailureSubject">
<summary>
Looks up a localized string similar to Message delivery failure.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.ErrorEmptyField">
<summary>
Looks up a localized string similar to This field cannot be empty.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.ErrorIncorrectEmailAddress">
<summary>
Looks up a localized string similar to Incorrect email address in %1 field.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.ErrorTagNameAlreadyExists">
<summary>
Looks up a localized string similar to Tag %1 already exists.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.ErrorTagNameCantBeEmpty">
<summary>
Looks up a localized string similar to Tag name cannot be empty.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.FieldNameBcc">
<summary>
Looks up a localized string similar to Bcc.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.FieldNameCc">
<summary>
Looks up a localized string similar to Cc.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.FieldNameFrom">
<summary>
Looks up a localized string similar to From.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.FieldNameTo">
<summary>
Looks up a localized string similar to To.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.ImapConnectionTimeoutError">
<summary>
Looks up a localized string similar to IMAP server connection timeout exceeded..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.ImapResponse">
<summary>
Looks up a localized string similar to IMAP response:.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.Pop3ConnectionTimeoutError">
<summary>
Looks up a localized string similar to POP3 server connection timeout exceeded..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.Pop3Response">
<summary>
Looks up a localized string similar to POP3 response:.
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.SmtpConnectionTimeoutError">
<summary>
Looks up a localized string similar to SMTP server connection timeout exceeded..
</summary>
</member>
<member name="P:ASC.Api.Mail.Resources.MailApiResource.SmtRresponse">
<summary>
Looks up a localized string similar to SMTP response:.
</summary>
</member>
</members>
</doc>

View File

@ -4,7 +4,7 @@
<name>ASC.Api.MailServer</name>
</assembly>
<members>
<member name="M:ASC.Api.MailServer.MailServerApi.CreateMailbox(System.String,System.String,System.Int32,System.String)">
<member name="M:ASC.Api.MailServer.MailServerApi.CreateMailbox(System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean)">
<summary>
Create mailbox
</summary>
@ -12,6 +12,8 @@
<param name="local_part"></param>
<param name="domain_id"></param>
<param name="user_id"></param>
<param name="notifyCurrent">Send message to creating mailbox's address</param>
<param name="notifyProfile">Send message to email from user profile</param>
<returns>MailboxData associated with tenant</returns>
<short>Create mailbox</short>
<category>Mailboxes</category>
@ -74,6 +76,35 @@
<short>Remove mailbox's aliases</short>
<category>Mailboxes</category>
</member>
<member name="M:ASC.Api.MailServer.MailServerApi.ChangeMailboxPassword(System.Int32,System.String)">
<summary>
Change mailbox password
</summary>
<param name="mailbox_id"></param>
<param name="password"></param>
<short>Change mailbox password</short>
<category>Mailboxes</category>
</member>
<member name="M:ASC.Api.MailServer.MailServerApi.IsAddressAlreadyRegistered(System.String,System.Int32)">
<summary>
Check existence of mailbox address
</summary>
<param name="local_part"></param>
<param name="domain_id"></param>
<short>Is server mailbox address exists</short>
<returns>True - address exists, False - not exists</returns>
<category>Mailboxes</category>
</member>
<member name="M:ASC.Api.MailServer.MailServerApi.IsAddressValid(System.String,System.Int32)">
<summary>
Validate mailbox address
</summary>
<param name="local_part"></param>
<param name="domain_id"></param>
<short>Is server mailbox address valid</short>
<returns>True - address valid, False - not valid</returns>
<category>Mailboxes</category>
</member>
<member name="M:ASC.Api.MailServer.MailServerApi.CreateMailGroup(System.String,System.Int32,System.Collections.Generic.List{System.Int32})">
<summary>
Create group address
@ -195,7 +226,7 @@
Deletes the selected web domain
</summary>
<param name="id">id of web domain</param>
<returns>id of web domain</returns>
<returns>MailOperationResult object</returns>
<short>Remove domain from mail server</short>
<category>Domains</category>
</member>

View File

@ -148,7 +148,7 @@
<category>Backup</category>
<returns>Backup Schedule</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.CreateBackupSchedule(ASC.Core.Common.Contracts.BackupStorageType,ASC.Web.Studio.Core.Backup.BackupAjaxHandler.StorageParams,System.Int32,ASC.Web.Studio.Core.Backup.BackupAjaxHandler.CronParams,System.Boolean)">
<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>
Create the backup schedule of the current portal
</summary>
@ -165,7 +165,7 @@
</summary>
<category>Backup</category>
</member>
<member name="M:ASC.Api.Portal.PortalApi.StartBackup(ASC.Core.Common.Contracts.BackupStorageType,ASC.Web.Studio.Core.Backup.BackupAjaxHandler.StorageParams,System.Boolean)">
<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>
Start a backup of the current portal
</summary>
@ -202,7 +202,7 @@
<category>Backup</category>
<returns>Backup History</returns>
</member>
<member name="M:ASC.Api.Portal.PortalApi.StartBackupRestore(System.String,ASC.Core.Common.Contracts.BackupStorageType,ASC.Web.Studio.Core.Backup.BackupAjaxHandler.StorageParams,System.Boolean)">
<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>
Start a data restore of the current portal
</summary>
@ -220,9 +220,15 @@
<category>Backup</category>
<returns>Restore Progress</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>
@ -235,13 +241,13 @@
<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)">
<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)">
<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)">
@ -250,6 +256,13 @@
<member name="M:ASC.Api.Portal.PortalApi.DeleteBarTips">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Portal.PortalApi.GetRandomPassword">
<summary>
Get random password
</summary>
<short>Get random password</short>
<visible>false</visible>
</member>
<member name="P:ASC.Api.Portal.PortalApi.Name">
<summary>
Api name entry

View File

@ -214,6 +214,20 @@
<returns>Message</returns>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.DetachFileFromMessage(System.Int32,System.Collections.Generic.IEnumerable{System.Int32})">
<summary>
Detaches the selected file from the message with the ID specified in the request
</summary>
<short>
Detach file from message
</short>
<category>Files</category>
<param name="messageid">Message ID</param>
<param name="files">File ID</param>
<returns>Message</returns>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.GetProjectRecentMessages">
<summary>
Returns the list of latest messages in the discussions within the project with the ID specified in the request
@ -295,14 +309,6 @@
<category>Discussions</category>
<param name="htmltext">html to create preview</param>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.GetReportTemplate(System.Int32)">
<summary>
</summary>
<category>Report</category>
<param name="reportid"></param>
<returns></returns>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.SaveReportTemplate(System.String,System.String,System.Int32,System.Int32,System.Boolean,ASC.Projects.Core.Domain.Reports.ReportType,System.Int32,System.Int32,System.Nullable{ASC.Projects.Core.Domain.TaskStatus},System.Guid,System.Guid,ASC.Projects.Core.Domain.Reports.ReportTimeInterval,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Int32,System.Boolean)">
<summary>
Creates the project report template with the parameters specified in the request. Most of the parameters are optional and depend on the report type selected.
@ -356,6 +362,14 @@
<param name="noResponsible" optional="true">Show or hide tasks without responsible</param>
<returns>Project report template</returns>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.GetReportTemplate(System.Int32)">
<summary>
</summary>
<category>Report</category>
<param name="reportid"></param>
<returns></returns>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.DeleteReportTemplate(System.Int32)">
<summary>
Deletes the project report template with the ID specified in the request
@ -552,6 +566,19 @@
<returns>project</returns>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.UpdateProjectTags(System.Int32,System.Collections.Generic.IEnumerable{System.Int32})">
<summary>
Updates the tags for the project with the selected project ID with the tags specified in the request
</summary>
<short>
Update project tags
</short>
<category>Projects</category>
<param name="id">Project ID</param>
<param name="tags">Tags</param>
<returns>project</returns>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.GetProjectTime(System.Int32)">
<summary>
Returns the detailed information about the time spent on the project with the ID specified in the request
@ -821,6 +848,21 @@
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.DetachFileFromEntity(ASC.Projects.Core.Domain.EntityType,System.Int32,System.Collections.Generic.IEnumerable{System.Int32})">
<summary>
Detaches the selected file from the entity (project, milestone, task) with the type and ID specified
</summary>
<short>
Detach file from entity
</short>
<category>Files</category>
<param name="entityType">Entity type </param>
<param name="entityID">Entity ID</param>
<param name="files">files</param>
<returns>Detached file</returns>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.UploadFilesToEntity(ASC.Projects.Core.Domain.EntityType,System.Int32,System.String,System.IO.Stream,System.Net.Mime.ContentType,System.Net.Mime.ContentDisposition,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase},System.Boolean,System.Boolean)">
<summary>
Uploads the selected files to the entity (project, milestone, task) with the type and ID specified
@ -994,7 +1036,7 @@
<member name="M:ASC.Api.Projects.ProjectApi.GetTask(System.Collections.Generic.IEnumerable{System.Int32})">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.GetTaskByFilter(System.Int32,System.Boolean,System.Nullable{System.Int32},System.Boolean,System.Int32,System.Nullable{ASC.Projects.Core.Domain.TaskStatus},System.Boolean,System.Guid,System.Nullable{System.Guid},System.Guid,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Int32)">
<member name="M:ASC.Api.Projects.ProjectApi.GetTaskByFilter(System.Int32,System.Boolean,System.Nullable{System.Int32},System.Boolean,System.Boolean,System.Int32,System.Nullable{ASC.Projects.Core.Domain.TaskStatus},System.Boolean,System.Guid,System.Nullable{System.Guid},System.Guid,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Int32)">
<summary>
Returns the list with the detailed information about all the tasks matching the filter parameters specified in the request
</summary>
@ -1014,6 +1056,7 @@
<param name="lastId">Last task ID</param>
<param name="myProjects">Tasks in My Projects</param>
<param name="myMilestones">Tasks in My Milestones</param>
<param name="nomilestone">Tasks without Milestone</param>
<param name="follow">Followed tasks</param>
<returns>List of tasks</returns>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
@ -1081,6 +1124,20 @@
<returns>Task</returns>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.DetachFileFromTask(System.Int32,System.Collections.Generic.List{System.Int32})">
<summary>
Detaches the selected file from the task with the ID specified in the request
</summary>
<short>
Detach file from task
</short>
<category>Files</category>
<param name="taskid">Task ID</param>
<param name="files">files</param>
<returns>Task</returns>
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.UpdateTask(System.Int32,ASC.Projects.Core.Domain.TaskStatus)">
<summary>
Updates the status of the task with the ID specified in the request
@ -1419,6 +1476,16 @@
<category>Tags</category>
<returns>List of tags</returns>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.CreateNewTag(System.String)">
<summary>
Creates new tag
</summary>
<short>
Tag
</short>
<category>Tags</category>
<returns>Created tag</returns>
</member>
<member name="M:ASC.Api.Projects.ProjectApi.GetProjectsByTags(System.String)">
<summary>
Returns the detailed list of all projects with the specified tag

View File

@ -9,6 +9,52 @@
Portal settings
</summary>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetSmtpSettings">
<summary>
Returns current portal SMTP settings
</summary>
<short>
Get SMTP settings
</short>
<returns>SmtpSettings data</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.SaveSmtpSettings(ASC.Api.Settings.Smtp.SmtpSettingsWrapper)">
<summary>
Save SMTP settings for current portal
</summary>
<short>
Save SMTP settings
</short>
<param name="smtpSettings">SMTP settings data</param>
<returns>SmtpSettings data</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.ResetSmtpSettings">
<summary>
Reset SMTP settings for current portal
</summary>
<short>
Reset SMTP settings
</short>
<returns>SmtpSettings data</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.TestSmtpSettings">
<summary>
Test SMTP settings for current portal (send test message to user email)
</summary>
<short>
Test SMTP settings
</short>
<returns>SmtpOperationStatus data</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetSmtpOperationStatus">
<summary>
Returns SMTP test process status
</summary>
<short>
Get SMTP test process status
</short>
<returns>SmtpOperationStatus object</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetSsoSettingsV2">
<summary>
Returns current portal SSO settings
@ -64,6 +110,23 @@
</short>
<returns>LDAPSupportSettings object</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetLdapCronSettings">
<summary>
Returns current portal LDAP AutoSync cron expression if any
</summary>
<short>
Get LDAP AutoSync Cron expression
</short>
<returns>string or null</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.SetLdapCronSettings(System.String)">
<summary>
Sets current portal LDAP AutoSync cron expression
</summary>
<short>
Sets LDAP AutoSync Cron expression
</short>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.SyncLdap">
<summary>
Start sync users and groups process by LDAP
@ -190,6 +253,22 @@
<param name="ids">Module ID list</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetEnabledModules">
<summary>
Return list of enabled modules
</summary>
<short>
Enabled modules
</short>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetPasswordSettings">
<summary>
Get portal password settings
</summary>
<short>
Password settings
</short>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.SetWebItemSecurity(System.String,System.Boolean,System.Collections.Generic.IEnumerable{System.Guid})">
<summary>
Set security settings for product, module or addons
@ -264,6 +343,12 @@
<param name="show">show tips for user</param>
<returns></returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.UpdateTipsSubscription">
<summary>
change tips&amp;tricks subscription
</summary>
<returns>subscription state</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.CompleteWizard">
<summary>
Complete Wizard
@ -271,12 +356,27 @@
<returns>WizardSettings</returns>
<visible>false</visible>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.SmsSettings(System.Boolean)">
<member name="M:ASC.Api.Settings.SettingsApi.TfaSettings(System.String)">
<summary>
Update two-factor authentication settings
</summary>
<param name="enable">Enable two-factor authentication</param>
<returns>Setting value</returns>
<param name="type">sms, app or none</param>
<returns>true if success</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.TfaAppGetCodes">
<visible>false</visible>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.TfaAppRequestNewCodes">
<summary>
Requests new backup codes for two-factor application
</summary>
<returns>New backup codes</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.TfaAppNewApp(System.Guid)">
<summary>
Unlinks current two-factor auth application
</summary>
<returns>Login url</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.CloseWelcomePopup">
<visible>false</visible>
@ -328,5 +428,66 @@
</summary>
<param name="id">Item id</param>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.UpdateEmailActivationSettings(System.Boolean)">
<summary>
update email activation settings
</summary>
<param name="show">show email activation panel for user</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>
Get WebItem Space Usage Statistics
</summary>
<param name="id">WebItem id</param>
<returns>UsageSpaceStatItemWrapper List</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetVisitStatistics(ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
<summary>
Get User Visit Statistics
</summary>
<param name="fromDate">From Date</param>
<param name="toDate">To Date</param>
<returns>ChartPointWrapper List</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetAllStorages">
<summary>
Get Storage
</summary>
<returns>Consumer</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetStorageProgress">
<summary>
Get Storage
</summary>
<returns>Consumer</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>
Get Storage
</summary>
<returns>Consumer</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetAllCdnStorages">
<summary>
Get Storage
</summary>
<returns>Consumer</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>
Get Storage
</summary>
<returns>Consumer</returns>
</member>
<member name="M:ASC.Api.Settings.SettingsApi.GetAllBackupStorages">
<summary>
Get Storage
</summary>
<returns>Consumer</returns>
</member>
</members>
</doc>

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -58,13 +58,24 @@
<param name="code">sms code</param>
<returns>tokent to use in 'Authorization' header when calling API methods</returns>
</member>
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.RegisterUserOnPersonal(System.String,System.String,System.Boolean)">
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.RegisterUserOnPersonal(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Request of invitation by email on personal.onlyoffice.com
</summary>
<param name="email">Email address</param>
<param name="lang">Culture</param>
<param name="spam">User consent to subscribe to the ONLYOFFICE newsletter</param>
<param name="analytics">Track analytics</param>
<visible>false</visible>
</member>
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.AuthenticateMe(System.String,System.String,System.String)">
<summary>
Check userName and password
</summary>
<param name="userName">user name or email</param>
<param name="password">password</param>
<param name="key"></param>
<exception cref="T:System.Security.Authentication.AuthenticationException">Thrown when not authenticated</exception>
<visible>false</visible>
</member>
<member name="P:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.Name">

View File

@ -1,6 +1,11 @@
<?xml version="1.0" encoding="utf-8" ?>
<autofac>
<components>
<container name="core">
<component
type="ASC.Common.Logging.Log, ASC.Common"
service="ASC.Common.Logging.ILog, ASC.Common" />
</container>
<container name ="api">
<component
type="ASC.Specific.AscApiConfiguration, ASC.Specific"
@ -22,10 +27,6 @@
service="ASC.Api.Interfaces.IApiAuthorization, ASC.Api"
instance-scope="single-instance"
name="asc_basic"/>
<component
type="ASC.Specific.Log4NetLog, ASC.Specific"
service="ASC.Api.Logging.ILog, ASC.Api"
instance-scope="single-instance"/>
<component
type="ASC.Specific.GlobalFilters.ProductSecurityFilter, ASC.Specific"
service="ASC.Api.Attributes.ApiCallFilter, ASC.Api"

View File

@ -42,7 +42,7 @@
<autofac configSource="web.autofac.config"/>
<system.web>
<customErrors mode="Off"/>
<compilation debug="true" targetFramework="4.0">
<compilation debug="true" targetFramework="4.7.2">
<assemblies>
<add assembly="System.Web, Version=4.0.0.0, Culture=neutral, PublicKeyToken=B03F5F7F11D50A3A"/>
<add assembly="System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=B77A5C561934E089"/>
@ -310,7 +310,7 @@
<level value="ALL" />
</logger>
<appender name="Site" type="log4net.Appender.RollingFileAppender">
<appender name="Site" type="ASC.Common.Logging.SelfCleaningAppender, ASC.Common">
<file value="..\Logs\Site.log" />
<encoding value="utf-8" />
<rollingstyle value="Size" />