r7: community dll
This commit is contained in:
parent
27831d8cdc
commit
55583f9cf6
@ -0,0 +1,78 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Text.RegularExpressions;
|
||||
using ASC.Api.Interfaces;
|
||||
using ASC.Common.DependencyInjection;
|
||||
using Autofac;
|
||||
|
||||
internal static class Documentation
|
||||
{
|
||||
private static List<MsDocEntryPoint> _points = new List<MsDocEntryPoint>();
|
||||
|
||||
public static void Load()
|
||||
{
|
||||
//Load documentation
|
||||
_points = GenerateDocs();
|
||||
}
|
||||
|
||||
private static List<MsDocEntryPoint> GenerateDocs()
|
||||
{
|
||||
var containerBuilder = AutofacConfigLoader.Load("api");
|
||||
containerBuilder.Register(c => c.Resolve<IApiRouteConfigurator>().RegisterEntryPoints())
|
||||
.As<IEnumerable<IApiMethodCall>>()
|
||||
.SingleInstance();
|
||||
|
||||
var container = containerBuilder.Build();
|
||||
|
||||
var entries = container.Resolve<IEnumerable<IApiMethodCall>>();
|
||||
|
||||
var apiEntryPoints = container.ComponentRegistry.Registrations.Where(x => typeof (IApiEntryPoint).IsAssignableFrom(x.Activator.LimitType)).ToList();
|
||||
|
||||
var generator = new MsDocDocumentGenerator(container);
|
||||
|
||||
foreach (var apiEntryPoint in entries.GroupBy(x => x.ApiClassType))
|
||||
{
|
||||
var point = apiEntryPoint;
|
||||
generator.GenerateDocForEntryPoint(
|
||||
apiEntryPoints.SingleOrDefault(x => x.Activator.LimitType == point.Key),
|
||||
apiEntryPoint.AsEnumerable());
|
||||
}
|
||||
|
||||
return generator.Points;
|
||||
}
|
||||
|
||||
public static MsDocEntryPoint GetDocs(string name)
|
||||
{
|
||||
return _points.SingleOrDefault(x => x.Name.Equals(name, StringComparison.OrdinalIgnoreCase));
|
||||
}
|
||||
|
||||
public static IEnumerable<MsDocEntryPoint> GetAll()
|
||||
{
|
||||
return _points;
|
||||
}
|
||||
|
||||
public static Dictionary<MsDocEntryPoint, Dictionary<MsDocEntryPointMethod, string>> Search(string query)
|
||||
{
|
||||
if (string.IsNullOrEmpty(query))
|
||||
{
|
||||
return new Dictionary<MsDocEntryPoint, Dictionary<MsDocEntryPointMethod, string>>();
|
||||
}
|
||||
|
||||
var terms = Regex.Split(query, @"\W+").Where(x => !String.IsNullOrEmpty(x));
|
||||
var result = _points.ToDictionary(
|
||||
x => x,
|
||||
ep => ep.Methods.Where(m => terms.All(
|
||||
term => (m.Summary != null && 0 <= m.Summary.IndexOf(term, StringComparison.OrdinalIgnoreCase)) ||
|
||||
(m.Category != null && 0 <= m.Category.IndexOf(term, StringComparison.OrdinalIgnoreCase)) ||
|
||||
(m.FunctionName != null && 0 <= m.FunctionName.IndexOf(term, StringComparison.OrdinalIgnoreCase)) ||
|
||||
(m.Notes != null && 0 <= m.Notes.IndexOf(term, StringComparison.OrdinalIgnoreCase)) ||
|
||||
(m.Path != null && 0 <= m.Path.IndexOf(term, StringComparison.OrdinalIgnoreCase)) ||
|
||||
(m.Remarks != null && 0 <= m.Remarks.IndexOf(term, StringComparison.OrdinalIgnoreCase)) ||
|
||||
(m.Returns != null && 0 <= m.Returns.IndexOf(term, StringComparison.OrdinalIgnoreCase)))
|
||||
)
|
||||
.ToDictionary(key => key, value => string.Empty)
|
||||
);
|
||||
return result;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,456 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Configuration;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using System.Runtime.Serialization;
|
||||
using System.Text.RegularExpressions;
|
||||
using System.Web;
|
||||
using System.Web.Routing;
|
||||
using System.Xml.Linq;
|
||||
using ASC.Api.Enums;
|
||||
using ASC.Api.Impl;
|
||||
using ASC.Api.Interfaces;
|
||||
using ASC.Api.Utils;
|
||||
using Autofac;
|
||||
using Autofac.Core;
|
||||
using log4net;
|
||||
|
||||
[DataContract(Name = "response", Namespace = "")]
|
||||
public class MsDocFunctionResponse
|
||||
{
|
||||
[DataMember(Name = "output")]
|
||||
public Dictionary<string, string> Outputs { get; set; }
|
||||
}
|
||||
|
||||
[DataContract(Name = "entrypoint", Namespace = "")]
|
||||
public class MsDocEntryPoint
|
||||
{
|
||||
[DataMember(Name = "summary")]
|
||||
public string Summary { get; set; }
|
||||
|
||||
[DataMember(Name = "remarks")]
|
||||
public string Remarks { get; set; }
|
||||
|
||||
[DataMember(Name = "name")]
|
||||
public string Name { get; set; }
|
||||
|
||||
[DataMember(Name = "example")]
|
||||
public string Example { get; set; }
|
||||
|
||||
[DataMember(Name = "functions")]
|
||||
public List<MsDocEntryPointMethod> Methods { get; set; }
|
||||
}
|
||||
|
||||
[DataContract(Name = "function", Namespace = "")]
|
||||
public class MsDocEntryPointMethod : IEquatable<MsDocEntryPointMethod>
|
||||
{
|
||||
[DataMember(Name = "summary")]
|
||||
public string Summary { get; set; }
|
||||
|
||||
[DataMember(Name = "authentification", EmitDefaultValue = true)]
|
||||
public bool Authentification { get; set; }
|
||||
|
||||
[DataMember(Name = "remarks")]
|
||||
public string Remarks { get; set; }
|
||||
|
||||
[DataMember(Name = "httpmethod")]
|
||||
public string HttpMethod { get; set; }
|
||||
|
||||
[DataMember(Name = "url")]
|
||||
public string Path { get; set; }
|
||||
|
||||
[DataMember(Name = "example")]
|
||||
public string Example { get; set; }
|
||||
|
||||
[DataMember(Name = "params")]
|
||||
public List<MsDocEntryPointMethodParams> Params { get; set; }
|
||||
|
||||
[DataMember(Name = "returns")]
|
||||
public string Returns { get; set; }
|
||||
|
||||
[DataMember(Name = "responses")]
|
||||
public List<MsDocFunctionResponse> Response { get; set; }
|
||||
|
||||
[DataMember(Name = "category")]
|
||||
public string Category { get; set; }
|
||||
|
||||
[DataMember(Name = "notes")]
|
||||
public string Notes { get; set; }
|
||||
|
||||
[DataMember(Name = "short")]
|
||||
public string ShortName { get; set; }
|
||||
|
||||
[DataMember(Name = "function")]
|
||||
public string FunctionName { get; set; }
|
||||
|
||||
public MsDocEntryPoint Parent { get; set; }
|
||||
|
||||
[DataMember(Name = "visible")]
|
||||
public bool Visible { get; set; }
|
||||
|
||||
public override bool Equals(object obj)
|
||||
{
|
||||
if (ReferenceEquals(null, obj)) return false;
|
||||
if (ReferenceEquals(this, obj)) return true;
|
||||
if (obj.GetType() != typeof(MsDocEntryPointMethod)) return false;
|
||||
return Equals((MsDocEntryPointMethod)obj);
|
||||
}
|
||||
|
||||
public bool Equals(MsDocEntryPointMethod other)
|
||||
{
|
||||
if (ReferenceEquals(null, other)) return false;
|
||||
if (ReferenceEquals(this, other)) return true;
|
||||
return Equals(other.Path, Path) && Equals(other.HttpMethod, HttpMethod);
|
||||
}
|
||||
|
||||
public override string ToString()
|
||||
{
|
||||
return string.Format("{0} {1}", HttpMethod, Path).ToLowerInvariant();
|
||||
}
|
||||
|
||||
public override int GetHashCode()
|
||||
{
|
||||
unchecked
|
||||
{
|
||||
return ((Path != null ? Path.GetHashCode() : 0) * 397) ^ (HttpMethod != null ? HttpMethod.GetHashCode() : 0);
|
||||
}
|
||||
}
|
||||
|
||||
public static bool operator ==(MsDocEntryPointMethod left, MsDocEntryPointMethod right)
|
||||
{
|
||||
return Equals(left, right);
|
||||
}
|
||||
|
||||
public static bool operator !=(MsDocEntryPointMethod left, MsDocEntryPointMethod right)
|
||||
{
|
||||
return !Equals(left, right);
|
||||
}
|
||||
}
|
||||
|
||||
[DataContract(Name = "param", Namespace = "")]
|
||||
public class MsDocEntryPointMethodParams
|
||||
{
|
||||
[DataMember(Name = "name")]
|
||||
public string Name { get; set; }
|
||||
|
||||
[DataMember(Name = "type")]
|
||||
public string Type { get; set; }
|
||||
|
||||
[DataMember(Name = "sendmethod")]
|
||||
public string Method { get; set; }
|
||||
|
||||
[DataMember(Name = "description")]
|
||||
public string Description { get; set; }
|
||||
|
||||
[DataMember(Name = "remarks")]
|
||||
public string Remarks { get; set; }
|
||||
|
||||
[DataMember(Name = "optional")]
|
||||
public bool IsOptional { get; set; }
|
||||
|
||||
[DataMember(Name = "visible")]
|
||||
public bool Visible { get; set; }
|
||||
}
|
||||
|
||||
public class MsDocDocumentGenerator
|
||||
{
|
||||
private static readonly Regex RouteRegex = new Regex(@"\{([^\}]+)\}", RegexOptions.Compiled);
|
||||
private readonly List<MsDocEntryPoint> _points = new List<MsDocEntryPoint>();
|
||||
private readonly string[] _responseFormats = (ConfigurationManager.AppSettings["enabled_response_formats"] ?? "").Split('|');
|
||||
|
||||
public MsDocDocumentGenerator(IContainer container)
|
||||
{
|
||||
Container = container;
|
||||
}
|
||||
|
||||
#region IApiDocumentGenerator Members
|
||||
|
||||
public IContainer Container { get; set; }
|
||||
|
||||
public List<MsDocEntryPoint> Points
|
||||
{
|
||||
get { return _points; }
|
||||
}
|
||||
|
||||
public void GenerateDocForEntryPoint(IComponentRegistration apiEntryPointRegistration, IEnumerable<IApiMethodCall> apiMethodCalls)
|
||||
{
|
||||
//Find the document
|
||||
var lookupDir = AppDomain.CurrentDomain.RelativeSearchPath;
|
||||
var docFile = Path.Combine(lookupDir, Path.GetFileName(apiEntryPointRegistration.Activator.LimitType.Assembly.Location).ToLowerInvariant().Replace(".dll", ".xml"));
|
||||
|
||||
if (!File.Exists(docFile))
|
||||
{
|
||||
//Build without doc
|
||||
BuildUndocumented(apiEntryPointRegistration, apiMethodCalls);
|
||||
return;
|
||||
}
|
||||
|
||||
var members = XDocument.Load(docFile).Root.ThrowIfNull(new ArgumentException("Bad documentation file " + docFile)).Element("members").Elements("member");
|
||||
//Find entry point first
|
||||
var entryPointDoc = members.SingleOrDefault(x => x.Attribute("name").ValueOrNull() == string.Format("T:{0}", apiEntryPointRegistration.Activator.LimitType.FullName))
|
||||
?? new XElement("member",
|
||||
new XElement("summary", "This entry point doesn't have documentation."),
|
||||
new XElement("remarks", ""));
|
||||
|
||||
var methodCallsDoc = from apiMethodCall in apiMethodCalls
|
||||
let memberdesc = (from member in members
|
||||
where member.Attribute("name").ValueOrNull() == GetMethodString(apiMethodCall.MethodCall)
|
||||
select member).SingleOrDefault()
|
||||
select new { apiMethod = apiMethodCall, description = memberdesc ?? CreateEmptyParams(apiMethodCall) };
|
||||
|
||||
//Ughh. we got all what we need now building
|
||||
var root = new MsDocEntryPoint
|
||||
{
|
||||
Summary = entryPointDoc.Element("summary").ValueOrNull(),
|
||||
Remarks = entryPointDoc.Element("remarks").ValueOrNull(),
|
||||
Name = apiEntryPointRegistration.Services.OfType<KeyedService>().First().ServiceKey.ToString(),
|
||||
Example = entryPointDoc.Element("example").ValueOrNull(),
|
||||
|
||||
Methods = (from methodCall in methodCallsDoc
|
||||
let pointMethod = new MsDocEntryPointMethod
|
||||
{
|
||||
Path = methodCall.apiMethod.FullPath,
|
||||
HttpMethod = methodCall.apiMethod.HttpMethod,
|
||||
Authentification = methodCall.apiMethod.RequiresAuthorization,
|
||||
FunctionName = GetFunctionName(methodCall.apiMethod.MethodCall.Name),
|
||||
Summary = methodCall.description.Element("summary").ValueOrNull(),
|
||||
Visible = !string.Equals(methodCall.description.Element("visible").ValueOrNull(), bool.FalseString, StringComparison.OrdinalIgnoreCase),
|
||||
Remarks = methodCall.description.Element("remarks").ValueOrNull().Replace(Environment.NewLine, @"<br />"),
|
||||
Returns = methodCall.description.Element("returns").ValueOrNull(),
|
||||
Example = methodCall.description.Element("example").ValueOrNull().Replace(Environment.NewLine, @"<br />"),
|
||||
Response = TryCreateResponse(methodCall.apiMethod, Container, methodCall.description.Element("returns")),
|
||||
Category = methodCall.description.Element("category").ValueOrNull(),
|
||||
Notes = methodCall.description.Element("notes").ValueOrNull(),
|
||||
ShortName = methodCall.description.Element("short").ValueOrNull(),
|
||||
Params = (from methodParam in methodCall.description.Elements("param")
|
||||
select new MsDocEntryPointMethodParams
|
||||
{
|
||||
Description = methodParam.ValueOrNull(),
|
||||
Name = methodParam.Attribute("name").ValueOrNull(),
|
||||
Remarks = methodParam.Attribute("remark").ValueOrNull(),
|
||||
IsOptional = string.Equals(methodParam.Attribute("optional").ValueOrNull(), bool.TrueString, StringComparison.OrdinalIgnoreCase),
|
||||
Visible = !string.Equals(methodParam.Attribute("visible").ValueOrNull(), bool.FalseString, StringComparison.OrdinalIgnoreCase),
|
||||
Type = methodCall.apiMethod.GetParams().Where(x => x.Name == methodParam.Attribute("name").ValueOrNull()).Select(x => GetParameterTypeRepresentation(x.ParameterType)).SingleOrDefault(),
|
||||
Method = GuesMethod(methodParam.Attribute("name").ValueOrNull(), methodCall.apiMethod.RoutingUrl, methodCall.apiMethod.HttpMethod)
|
||||
}).ToList()
|
||||
}
|
||||
where pointMethod.Visible
|
||||
select pointMethod).ToList()
|
||||
};
|
||||
Points.Add(root);
|
||||
}
|
||||
|
||||
private static string GetParameterTypeRepresentation(Type paramType)
|
||||
{
|
||||
return paramType.IsEnum
|
||||
? string.Join(", ", Enum.GetNames(paramType))
|
||||
: paramType.ToString();
|
||||
}
|
||||
|
||||
private void BuildUndocumented(IComponentRegistration apiEntryPointRegistration, IEnumerable<IApiMethodCall> apiMethodCalls)
|
||||
{
|
||||
var root = new MsDocEntryPoint
|
||||
{
|
||||
Name = apiEntryPointRegistration.Services.OfType<KeyedService>().First().ServiceKey.ToString(),
|
||||
Remarks = "This entry point doesn't have any documentation. This is generated automaticaly using metadata",
|
||||
Methods = (from methodCall in apiMethodCalls
|
||||
select new MsDocEntryPointMethod
|
||||
{
|
||||
Path = methodCall.FullPath,
|
||||
HttpMethod = methodCall.HttpMethod,
|
||||
FunctionName = GetFunctionName(methodCall.MethodCall.Name),
|
||||
Authentification = methodCall.RequiresAuthorization,
|
||||
Response = TryCreateResponse(methodCall, Container, null),
|
||||
Params = (from methodParam in
|
||||
methodCall.GetParams()
|
||||
select new MsDocEntryPointMethodParams
|
||||
{
|
||||
Name = methodParam.Name,
|
||||
Visible = true,
|
||||
Type = GetParameterTypeRepresentation(methodParam.ParameterType),
|
||||
Method =
|
||||
GuesMethod(
|
||||
methodParam.Name,
|
||||
methodCall.RoutingUrl, methodCall.HttpMethod)
|
||||
}
|
||||
).ToList()
|
||||
}
|
||||
).ToList()
|
||||
};
|
||||
Points.Add(root);
|
||||
}
|
||||
|
||||
private static string GetFunctionName(string functionName)
|
||||
{
|
||||
return Regex.Replace(Regex.Replace(functionName, "[a-z][A-Z]+", match => (match.Value[0] + " " + match.Value.Substring(1, match.Value.Length - 2) + (" " + match.Value[match.Value.Length - 1]).ToLowerInvariant())), @"\s+", " ");
|
||||
}
|
||||
|
||||
private static XElement CreateEmptyParams(IApiMethodCall apiMethodCall)
|
||||
{
|
||||
return new XElement("description", apiMethodCall.GetParams().Select(x => new XElement("param", new XAttribute("name", x.Name))));
|
||||
}
|
||||
|
||||
private readonly HashSet<Type> _alreadyRegisteredTypes = new HashSet<Type>();
|
||||
|
||||
private List<MsDocFunctionResponse> TryCreateResponse(IApiMethodCall apiMethod, IContainer container, XElement returns)
|
||||
{
|
||||
var samples = new List<MsDocFunctionResponse>();
|
||||
var returnType = apiMethod.MethodCall.ReturnType;
|
||||
var collection = false;
|
||||
if (apiMethod.MethodCall.ReturnType.IsGenericType)
|
||||
{
|
||||
//It's collection
|
||||
returnType = apiMethod.MethodCall.ReturnType.GetGenericArguments().FirstOrDefault();
|
||||
collection = true;
|
||||
}
|
||||
if (returnType != null)
|
||||
{
|
||||
var sample = returnType.GetMethod("GetSample", BindingFlags.Static | BindingFlags.Public);
|
||||
if (sample != null)
|
||||
{
|
||||
samples = GetSamples(apiMethod, container, sample, collection, returnType).ToList();
|
||||
_alreadyRegisteredTypes.Add(returnType);
|
||||
}
|
||||
else if (returns != null && returns.Elements("see").Any())
|
||||
{
|
||||
var cref = returns.Elements("see").Attributes("cref").FirstOrDefault().ValueOrNull();
|
||||
if (!string.IsNullOrEmpty(cref) && cref.StartsWith("T:"))
|
||||
{
|
||||
var classname = cref.Substring(2);
|
||||
//Get the type
|
||||
try
|
||||
{
|
||||
|
||||
var crefType = Type.GetType(classname) ??
|
||||
_alreadyRegisteredTypes.SingleOrDefault(x => x.Name.Equals(classname, StringComparison.OrdinalIgnoreCase)) ??
|
||||
apiMethod.MethodCall.Module.GetType(classname, true) ??
|
||||
apiMethod.MethodCall.Module.GetTypes().SingleOrDefault(x => x.Name.Equals(classname, StringComparison.OrdinalIgnoreCase)) ??
|
||||
AppDomain.CurrentDomain.GetAssemblies().SelectMany(x => x.GetTypes()).SingleOrDefault(x => x.Name.Equals(classname, StringComparison.OrdinalIgnoreCase));
|
||||
|
||||
if (crefType != null)
|
||||
{
|
||||
sample = crefType.GetMethod("GetSample", BindingFlags.Static | BindingFlags.Public);
|
||||
if (sample != null)
|
||||
{
|
||||
samples = GetSamples(apiMethod, container, sample, collection, crefType).ToList();
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception)
|
||||
{
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return samples;
|
||||
}
|
||||
|
||||
private IEnumerable<MsDocFunctionResponse> GetSamples(IApiMethodCall apiMethod, IContainer container, MethodInfo sample, bool collection, Type returnType)
|
||||
{
|
||||
try
|
||||
{
|
||||
using (var lifetimeScope = container.BeginLifetimeScope())
|
||||
{
|
||||
var routeContext = new RequestContext(new HttpContextWrapper(HttpContext.Current), new RouteData());
|
||||
var apiContext = lifetimeScope.Resolve<ApiContext>(new NamedParameter("requestContext", routeContext));
|
||||
var response = lifetimeScope.Resolve<IApiStandartResponce>();
|
||||
response.Status = ApiStatus.Ok;
|
||||
|
||||
apiContext.RegisterType(returnType);
|
||||
|
||||
var sampleResponse = sample.Invoke(null, new object[0]);
|
||||
if (collection)
|
||||
{
|
||||
//wrap in array
|
||||
sampleResponse = new List<object> { sampleResponse };
|
||||
}
|
||||
response.Response = sampleResponse;
|
||||
|
||||
var serializers = container.Resolve<IEnumerable<IApiSerializer>>().Where(x => x.CanSerializeType(apiMethod.MethodCall.ReturnType));
|
||||
return serializers.Select(apiResponder => new MsDocFunctionResponse
|
||||
{
|
||||
Outputs = CreateResponse(apiResponder, response, apiContext)
|
||||
});
|
||||
}
|
||||
}
|
||||
catch (Exception err)
|
||||
{
|
||||
LogManager.GetLogger("ASC.Api").Error(err);
|
||||
return Enumerable.Empty<MsDocFunctionResponse>();
|
||||
}
|
||||
}
|
||||
|
||||
private Dictionary<string, string> CreateResponse(IApiSerializer apiResponder, IApiStandartResponce response, ApiContext apiContext)
|
||||
{
|
||||
var examples = new Dictionary<string, string>();
|
||||
foreach (var extension in apiResponder.GetSupportedExtensions().Where(extension => _responseFormats.Contains(extension)))
|
||||
{
|
||||
//Create request context
|
||||
using (var writer = new StringWriter())
|
||||
{
|
||||
var contentType = apiResponder.RespondTo(response, writer, "dummy" + extension, string.Empty, true, false);
|
||||
writer.Flush();
|
||||
examples[contentType.MediaType] = writer.GetStringBuilder().ToString();
|
||||
}
|
||||
}
|
||||
return examples;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
private static string GuesMethod(string textAttr, string routingUrl, string httpmethod)
|
||||
{
|
||||
if ("get".Equals(httpmethod, StringComparison.OrdinalIgnoreCase))
|
||||
return "url";
|
||||
var matches = RouteRegex.Matches(routingUrl);
|
||||
textAttr = textAttr.ToLowerInvariant();
|
||||
return
|
||||
matches.Cast<Match>().Where(x => x.Success && x.Groups[1].Success).Select(
|
||||
x => x.Groups[1].Value.ToLowerInvariant()).Any(
|
||||
routeConstr => routeConstr == textAttr || routeConstr.StartsWith(textAttr + ":"))
|
||||
? "url"
|
||||
: "body";
|
||||
}
|
||||
|
||||
public static string GetMethodString(MethodBase methodCall)
|
||||
{
|
||||
var str = string.Format("M:{0}.{1}", methodCall.DeclaringType.FullName, methodCall.Name);
|
||||
var callParam = methodCall.GetParameters();
|
||||
if (callParam.Length > 0)
|
||||
{
|
||||
str += string.Format("({0})",
|
||||
string.Join(",", callParam.Select(x => MakeParamName(x.ParameterType)).ToArray()));
|
||||
}
|
||||
return str;
|
||||
}
|
||||
|
||||
private static string MakeParamName(Type parameterType)
|
||||
{
|
||||
var name = parameterType.FullName.Replace('+', '.');
|
||||
name = Regex.Replace(name, @"\[.+\]", "");
|
||||
if (parameterType.IsGenericType)
|
||||
{
|
||||
name = Regex.Replace(name, @"`\d+", "");
|
||||
var genericTypes = parameterType.GetGenericArguments();
|
||||
name += "{" + string.Join(",", genericTypes.Select(MakeParamName).ToArray()) + "}";
|
||||
}
|
||||
return name;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
internal static class XmlExt
|
||||
{
|
||||
internal static string ValueOrNull(this XElement element)
|
||||
{
|
||||
return element == null ? "" : element.Value;
|
||||
}
|
||||
|
||||
internal static string ValueOrNull(this XAttribute element)
|
||||
{
|
||||
return element == null ? "" : element.Value;
|
||||
}
|
||||
}
|
||||
@ -1,9 +1,33 @@
|
||||
using System;
|
||||
using System.Web;
|
||||
using log4net;
|
||||
|
||||
public class Global : HttpApplication
|
||||
public class Global : HttpApplication
|
||||
{
|
||||
private static readonly object Locker = new object();
|
||||
private static volatile bool _initialized;
|
||||
|
||||
protected void Application_BeginRequest(object sender, EventArgs e)
|
||||
{
|
||||
if (!_initialized)
|
||||
{
|
||||
lock (Locker)
|
||||
{
|
||||
if (!_initialized)
|
||||
{
|
||||
_initialized = true;
|
||||
|
||||
try
|
||||
{
|
||||
LogManager.GetLogger("ASC").Debug("Generate documentations");
|
||||
Documentation.Load();
|
||||
}
|
||||
catch (Exception error)
|
||||
{
|
||||
LogManager.GetLogger("ASC").Error(error);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.ActiveDirectory.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.ActiveDirectory.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.CRM.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.CRM.dll
Normal file
Binary file not shown.
3500
helpcenter.r7-office.ru/Web/Bin/ASC.Api.CRM.xml
Normal file
3500
helpcenter.r7-office.ru/Web/Bin/ASC.Api.CRM.xml
Normal file
File diff suppressed because it is too large
Load Diff
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Calendar.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Calendar.dll
Normal file
Binary file not shown.
692
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Calendar.xml
Normal file
692
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Calendar.xml
Normal file
@ -0,0 +1,692 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Calendar</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:ASC.Api.Calendar.BusinessObjects.Calendar.SecurityId">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.BusinessObjects.Calendar.ObjectType">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.BusinessObjects.Event.ObjectType">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.#ctor(ASC.Api.Impl.ApiContext)">
|
||||
<summary>
|
||||
Constructor
|
||||
</summary>
|
||||
<param name="context"></param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetEventDays(ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
|
||||
<summary>
|
||||
Returns the list of all dates which contain the events from the displayed calendars
|
||||
</summary>
|
||||
<short>
|
||||
Calendar events
|
||||
</short>
|
||||
<param name="startDate">Period start date</param>
|
||||
<param name="endDate">Period end date</param>
|
||||
<returns>Date list</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.LoadCalendars(ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime)">
|
||||
<summary>
|
||||
Returns the list of calendars and subscriptions with the events for the current user for the selected period
|
||||
</summary>
|
||||
<short>
|
||||
Calendars and subscriptions
|
||||
</short>
|
||||
<param name="startDate">Period start date</param>
|
||||
<param name="endDate">Period end date</param>
|
||||
<returns>List of calendars and subscriptions with events</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.LoadSubscriptions">
|
||||
<summary>
|
||||
Returns the list of all subscriptions available to the user
|
||||
</summary>
|
||||
<short>
|
||||
Subscription list
|
||||
</short>
|
||||
<returns>List of subscriptions</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.ManageSubscriptions(System.Collections.Generic.IEnumerable{ASC.Api.Calendar.CalendarApi.SubscriptionState})">
|
||||
<summary>
|
||||
Updates the subscription state either subscribing or unsubscribing the user to/from it
|
||||
</summary>
|
||||
<short>
|
||||
Update subscription
|
||||
</short>
|
||||
<param name="states">Updated subscription states</param>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendarById(System.String)">
|
||||
<summary>
|
||||
Returns the detailed information about the calendar with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Calendar by ID
|
||||
</short>
|
||||
<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})">
|
||||
<summary>
|
||||
Creates the new calendar with the parameters (name, description, color, etc.) specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create calendar
|
||||
</short>
|
||||
<param name="name">Calendar name</param>
|
||||
<param name="description">Calendar description</param>
|
||||
<param name="textColor">Event text color</param>
|
||||
<param name="backgroundColor">Event background color</param>
|
||||
<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>
|
||||
<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})">
|
||||
<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>
|
||||
<short>
|
||||
Update calendar
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<param name="name">Calendar new name</param>
|
||||
<param name="description">Calendar new description</param>
|
||||
<param name="textColor">Event text color</param>
|
||||
<param name="backgroundColor">Event background color</param>
|
||||
<param name="timeZone">Calendar time zone</param>
|
||||
<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>
|
||||
<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)">
|
||||
<summary>
|
||||
Change the calendar display parameters specified in the request for the current user
|
||||
</summary>
|
||||
<short>
|
||||
Update calendar user view
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<param name="name">Calendar name</param>
|
||||
<param name="textColor">Event text color</param>
|
||||
<param name="backgroundColor">Event background color</param>
|
||||
<param name="timeZone">Calendar time zone</param>
|
||||
<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>
|
||||
<returns>Updated calendar</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveCalendar(System.Int32)">
|
||||
<summary>
|
||||
Deletes the calendar with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Delete calendar
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendariCalUrl(System.String)">
|
||||
<summary>
|
||||
Returns the link for the iCal associated with the calendar with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Get iCal link
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<returns>iCal link</returns>
|
||||
</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
|
||||
</summary>
|
||||
<short>Get iCal feed</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<param name="signature">Signature</param>
|
||||
<remarks>To get the feed you need to use the method returning the iCal feed link (it will generate the necessary signature)</remarks>
|
||||
<returns>Calendar iCal feed</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.ImportEvents(System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
|
||||
<summary>
|
||||
Imports the events from the iCal files
|
||||
</summary>
|
||||
<short>
|
||||
Import iCal
|
||||
</short>
|
||||
<param name="files">iCal formatted files with the events to be imported</param>
|
||||
<returns>Returns the number of imported events</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.ImportEvents(System.Int32,System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
|
||||
<summary>
|
||||
Imports the events from the iCal files to the existing calendar
|
||||
</summary>
|
||||
<short>
|
||||
Import iCal
|
||||
</short>
|
||||
<param name="calendarId">ID for the calendar which serves as the future storage base for the imported events</param>
|
||||
<param name="files">iCal formatted files with the events to be imported</param>
|
||||
<returns>Returns the number of imported events</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.ImportEvents(System.Int32,System.String)">
|
||||
<summary>
|
||||
Imports the events from the iCal files
|
||||
</summary>
|
||||
<short>
|
||||
Import iCal
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<param name="iCalString">iCal formatted string</param>
|
||||
<returns>Returns the number of imported events</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.CreateCalendarStream(System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Creates a calendar by the link to the external iCal feed
|
||||
</summary>
|
||||
<short>
|
||||
Create calendar
|
||||
</short>
|
||||
<param name="iCalUrl">Link to the external iCal feed</param>
|
||||
<param name="name">Calendar name</param>
|
||||
<param name="textColor">Event text name</param>
|
||||
<param name="backgroundColor">Event background name</param>
|
||||
<returns>Created calendar</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.AddEvent(System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam})">
|
||||
<summary>
|
||||
Creates the new event in the default calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create new event
|
||||
</short>
|
||||
<param name="name">Event name</param>
|
||||
<param name="description">Event description</param>
|
||||
<param name="startDate">Event start date</param>
|
||||
<param name="endDate">Event end date</param>
|
||||
<param name="repeatType">Event recurrence type (RRULE string in iCal format)</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="isAllDayLong">Event duration type: all day long or not</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</param>
|
||||
<returns>Event list</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.AddEvent(System.Int32,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam})">
|
||||
<summary>
|
||||
Creates the new event in the selected calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create new event
|
||||
</short>
|
||||
<param name="calendarId">ID of the calendar where the event is created</param>
|
||||
<param name="name">Event name</param>
|
||||
<param name="description">Event description</param>
|
||||
<param name="startDate">Event start date</param>
|
||||
<param name="endDate">Event end date</param>
|
||||
<param name="repeatType">Event recurrence type (RRULE string in iCal format)</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="isAllDayLong">Event duration type: all day long or not</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</param>
|
||||
<returns>Event list</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.Update(System.String,System.Int32,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.String,ASC.Web.Core.Calendars.EventAlertType,System.Boolean,System.Collections.Generic.List{ASC.Api.Calendar.CalendarApi.SharingParam},ASC.Web.Core.Calendars.EventStatus)">
|
||||
<summary>
|
||||
Updates the existing event in the selected calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Update event
|
||||
</short>
|
||||
<param name="calendarId">ID of the calendar where the event belongs</param>
|
||||
<param name="eventId">Event ID</param>
|
||||
<param name="name">Event new name</param>
|
||||
<param name="description">Event new description</param>
|
||||
<param name="startDate">Event start date</param>
|
||||
<param name="endDate">Event end date</param>
|
||||
<param name="repeatType">Event recurrence type (RRULE string in iCal format)</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="isAllDayLong">Event duration type: all day long or not</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</param>
|
||||
<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})">
|
||||
<summary>
|
||||
Creates the new event in the selected calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create new event
|
||||
</short>
|
||||
<param name="calendarId">ID of the calendar where the event is created</param>
|
||||
<param name="ics">Event in iCal format</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</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})">
|
||||
<summary>
|
||||
Updates the existing event in the selected calendar with the parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Update event
|
||||
</short>
|
||||
<param name="eventId">Event ID</param>
|
||||
<param name="calendarId">ID of the calendar where the event belongs</param>
|
||||
<param name="ics">Event in iCal format</param>
|
||||
<param name="alertType">Event notification type</param>
|
||||
<param name="sharingOptions">Event sharing access parameters</param>
|
||||
<returns>Updated event</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.RemoveEvent(System.Int32)">
|
||||
<summary>
|
||||
Deletes the whole event from the calendar (all events in the series)
|
||||
</summary>
|
||||
<short>
|
||||
Delete event series
|
||||
</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)">
|
||||
<summary>
|
||||
Deletes one event from the series of recurrent events
|
||||
</summary>
|
||||
<short>
|
||||
Delete event
|
||||
</short>
|
||||
<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>
|
||||
<returns>Updated event series collection</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.UnsubscribeEvent(System.Int32)">
|
||||
<summary>
|
||||
Unsubscribes the current user from the event with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Unsubscribe from event
|
||||
</short>
|
||||
<param name="eventId">Event ID</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetEventHistoryByUid(System.String)">
|
||||
<summary>
|
||||
Returns the event in ics format from history
|
||||
</summary>
|
||||
<short>
|
||||
Returns the event in ics format from history
|
||||
</short>
|
||||
<param name="eventUid">Event UID</param>
|
||||
<returns>Event History</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetEventHistoryById(System.Int32)">
|
||||
<summary>
|
||||
Returns the event in ics format from history
|
||||
</summary>
|
||||
<short>
|
||||
Returns the event in ics format from history
|
||||
</short>
|
||||
<param name="eventId">Event ID</param>
|
||||
<returns>Event History</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetCalendarSharingOptions(System.Int32)">
|
||||
<summary>
|
||||
Returns the sharing access parameters to the calendar with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Get access parameters
|
||||
</short>
|
||||
<param name="calendarId">Calendar ID</param>
|
||||
<returns>Sharing access parameters</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.CalendarApi.GetDefaultSharingOptions">
|
||||
<summary>
|
||||
Returns the default values for the sharing access parameters
|
||||
</summary>
|
||||
<short>
|
||||
Get default access
|
||||
</short>
|
||||
<returns>Default sharing access parameters</returns>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.IEmitter">
|
||||
<summary>
|
||||
Defines all of the basic operations that must be implemented by parser emitters.
|
||||
</summary>
|
||||
<remarks>
|
||||
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.Parser">
|
||||
<summary>
|
||||
Parse iCalendar rfc2445 streams and convert to another format based on the emitter used.
|
||||
</summary>
|
||||
|
||||
<remarks>
|
||||
This class is the main entry point for the ICalParser library. A parser is created
|
||||
with a TextReader that contains the iCalendar stream to be parsed, and an IEmitter, which
|
||||
is used to transform the iCalendar into another format.
|
||||
|
||||
Each iCalendar format file is in the form:
|
||||
|
||||
ID[[;attr1;attr2;attr3;...;attrn]:value]
|
||||
|
||||
where ID is the main keyword identifying the iCalendar entry, followed optionally by a
|
||||
set of attributes and a single value. The parser works by identifying the specific IDs,
|
||||
attributes and values, categorizing them based on similar 'behaviour' (as defined in the <code>Token</code>
|
||||
class) and passing on recognized symbols to the emitter for further processing.
|
||||
|
||||
The error recovery policy of the parser is pretty simple. When an error is detected, it is recorded,
|
||||
and the rest of the (possibly folded) line is read, and parsing continues.
|
||||
</remarks>
|
||||
|
||||
<example>
|
||||
The following snippet will read the contents of the file 'myCalendar.ics', which the
|
||||
parser will expect to contain iCalendar statements, and will write the RdfICalendar
|
||||
equivalent to standard output.
|
||||
<code>
|
||||
RDFEmitter emitter = new RDFEmitter( );
|
||||
StreamReader reader = new StreamReader( "myCalendar.ics" );
|
||||
Parser parser = new Parser( reader, emitter );
|
||||
parser.Parse( );
|
||||
Console.WriteLine( emitter.Rdf );
|
||||
</code>
|
||||
</example>
|
||||
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.#ctor(System.IO.TextReader,ASC.Api.Calendar.iCalParser.IEmitter)">
|
||||
<summary>
|
||||
Create a new iCalendar parser.
|
||||
</summary>
|
||||
<param name="reader">The reader that contains the stream of text iCalendar</param>
|
||||
<param name="_emitter">The emitter that will transform the iCalendar elements</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.Parse">
|
||||
<summary>
|
||||
Main entry point for starting the Parser.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.Parse(System.Boolean)">
|
||||
<summary>
|
||||
Alternate entry point for starting the parser.
|
||||
</summary>
|
||||
<param name="emitHandT">Indicates if the emitter should be told to emit headers
|
||||
and trailers before and after emitting the iCalendar body</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.parseID">
|
||||
<summary>
|
||||
Parse the first field (ID) of the line. Returns a boolean on weather or not the
|
||||
method sucesfully recognized an ID. If not, the method insures that the scanner
|
||||
will start at the beginning of a new line.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.parseAttributes(ASC.Api.Calendar.iCalParser.Scanner)">
|
||||
<summary>
|
||||
Parse the list of attributes - separated by ';'s. Attributes always are in the
|
||||
form 'id=value' and indicate key/value pairs in the iCalendar attribute format.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Parser.parseValue">
|
||||
<summary>
|
||||
Parse the value. The value is the last data item on a iCalendar input line.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.ParserError">
|
||||
<summary>
|
||||
Basic error handling mechanism for the Parser
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.Scanner">
|
||||
<summary>
|
||||
The scanner is responsible for tokenizing iCalendar (RFC2445) files for use by the
|
||||
parser.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Scanner.GetNextToken(ASC.Api.Calendar.iCalParser.ScannerState)">
|
||||
<summary>
|
||||
Returns the next token in the file. Returns null on EOF.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Calendar.iCalParser.Scanner.ConsumeToEOL">
|
||||
<summary>
|
||||
This method is used for error recovery, get the rest of the line, including
|
||||
folded lines, and position on a fresh line or EOF
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.iCalParser.Token">
|
||||
<summary>
|
||||
Represents the individual tokens returned from the scanner to the parser. Note that the
|
||||
Token creation process is sensitive to the ScannerState. This state is defined by what context
|
||||
the scanner currently is in - Parsing IDs, Parmeters, or values:
|
||||
e.g. the iCalendar grammar defines the following possible states
|
||||
id;id=parm:value
|
||||
each string parsed out of the value has to be treated differently (eg. quoted strings are
|
||||
allowed in 'parm' but not in 'id')
|
||||
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.Notification.CalendarPatternResource">
|
||||
<summary>
|
||||
A strongly-typed resource class, for looking up localized strings, etc.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.ResourceManager">
|
||||
<summary>
|
||||
Returns the cached ResourceManager instance used by this class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.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.Calendar.Notification.CalendarPatternResource.CalendarSharingEmailPattern">
|
||||
<summary>
|
||||
Looks up a localized string similar to #if($SharingType == "calendar")
|
||||
h1.Access Granted to Calendar: $CalendarName
|
||||
|
||||
|
||||
"$UserName":"$UserLink" has granted you the access to the calendar: $CalendarName
|
||||
|
||||
^You receive this email because you are a registered user of the "${__VirtualRootPath}":"${__VirtualRootPath}" portal. If you do not want to receive the notifications about the calendars shared with you, please manage your "subscription settings":"$RecipientSubscriptionConfigURL".^
|
||||
#end
|
||||
#if($SharingType == "event")
|
||||
h1.Access Granted to Event: $ [rest of string was truncated]";.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.CalendarSharingJabberPattern">
|
||||
<summary>
|
||||
Looks up a localized string similar to #if($SharingType == "calendar")
|
||||
Calendar. Access Granted to Calendar: $CalendarName
|
||||
#end
|
||||
#if($SharingType == "event")
|
||||
Calendar. Access Granted to Event: $EventName
|
||||
#end.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.CalendarSharingSubject">
|
||||
<summary>
|
||||
Looks up a localized string similar to #if($SharingType == "calendar")
|
||||
Calendar. Access granted to calendar: $CalendarName
|
||||
#end
|
||||
#if($SharingType == "event")
|
||||
Calendar. Access granted to event: $EventName
|
||||
#end.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.EventAlertEmailPattern">
|
||||
<summary>
|
||||
Looks up a localized string similar to h1.Reminder about the Event: $EventName
|
||||
|
||||
|
||||
The $EventName event is appointed for $EventStartDate #if($EventEndDate!="")- $EventEndDate #end
|
||||
#if($EventDescription!="")
|
||||
|
||||
Event Description:
|
||||
|
||||
$EventDescription
|
||||
#end
|
||||
|
||||
|
||||
^You receive this email because you are a registered user of the "${__VirtualRootPath}":"${__VirtualRootPath}" portal. If you do not want to receive the event reminders, please manage your "subscription settings":"$RecipientSubscriptionConfigURL".^.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.EventAlertJabberPattern">
|
||||
<summary>
|
||||
Looks up a localized string similar to The $EventName event is appointed for $EventStartDate #if($EventEndDate!="")- $EventEndDate #end
|
||||
#if($EventDescription!="")
|
||||
|
||||
Event Description:
|
||||
|
||||
$EventDescription
|
||||
#end.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatternResource.EventAlertSubject">
|
||||
<summary>
|
||||
Looks up a localized string similar to Calendar. Reminder about the event: $EventName.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.Notification.CalendarPatterns">
|
||||
<summary>
|
||||
A strongly-typed resource class, for looking up localized strings, etc.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatterns.ResourceManager">
|
||||
<summary>
|
||||
Returns the cached ResourceManager instance used by this class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Notification.CalendarPatterns.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.Calendar.Notification.CalendarPatterns.calendar_patterns">
|
||||
<summary>
|
||||
Looks up a localized string similar to <patterns>
|
||||
<formatter type="ASC.Notify.Patterns.NVelocityPatternFormatter, ASC.Common" />
|
||||
|
||||
<pattern id="CalendarSharingPattern" sender="email.sender">
|
||||
<subject resource="|CalendarSharingSubject|ASC.Api.Calendar.Notification.CalendarPatternResource,ASC.Api.Calendar" />
|
||||
<body styler="ASC.Notify.Textile.TextileStyler,ASC.Notify.Textile" resource="|CalendarSharingEmailPattern|ASC.Api.Calendar.Notification.CalendarPatternResource,ASC.Api.Calendar" />
|
||||
</pattern>
|
||||
<pattern id="CalendarSharing [rest of string was truncated]";.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Calendar.Resources.CalendarApiResource">
|
||||
<summary>
|
||||
A strongly-typed resource class, for looking up localized strings, etc.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ResourceManager">
|
||||
<summary>
|
||||
Returns the cached ResourceManager instance used by this class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.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.Calendar.Resources.CalendarApiResource.BirthdayCalendarDescription">
|
||||
<summary>
|
||||
Looks up a localized string similar to Reminds about users' birthdays.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.BirthdayCalendarName">
|
||||
<summary>
|
||||
Looks up a localized string similar to Users' birthdays.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.CommonCalendarsGroup">
|
||||
<summary>
|
||||
Looks up a localized string similar to Common calendars.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.DefaultCalendarName">
|
||||
<summary>
|
||||
Looks up a localized string similar to My calendar.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ErrorAccessDenied">
|
||||
<summary>
|
||||
Looks up a localized string similar to Access Denied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ErrorEmptyName">
|
||||
<summary>
|
||||
Looks up a localized string similar to Name can't be empty.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ErrorIncorrectDateFormat">
|
||||
<summary>
|
||||
Looks up a localized string similar to Date format is incorrect.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ErrorItemNotFound">
|
||||
<summary>
|
||||
Looks up a localized string similar to Item not found.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.FullAccessOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Full Access.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.iCalCalendarsGroup">
|
||||
<summary>
|
||||
Looks up a localized string similar to iCal Calendars.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.NoNameCalendar">
|
||||
<summary>
|
||||
Looks up a localized string similar to No title.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.NoNameEvent">
|
||||
<summary>
|
||||
Looks up a localized string similar to No title.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.OwnerOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Owner.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.PersonalCalendarsGroup">
|
||||
<summary>
|
||||
Looks up a localized string similar to Personal calendars.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.ReadOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Read Only.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.SharedCalendarsGroup">
|
||||
<summary>
|
||||
Looks up a localized string similar to Calendars shared with me.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.SharedEventsCalendarDescription">
|
||||
<summary>
|
||||
Looks up a localized string similar to Here are all events, which another users shared with me.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.SharedEventsCalendarName">
|
||||
<summary>
|
||||
Looks up a localized string similar to Events shared with me.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Calendar.Resources.CalendarApiResource.WrongiCalFeedLink">
|
||||
<summary>
|
||||
Looks up a localized string similar to An invalid reference to iCal.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Community.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Community.dll
Normal file
Binary file not shown.
927
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Community.xml
Normal file
927
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Community.xml
Normal file
@ -0,0 +1,927 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Community</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:ASC.Api.Community.CommunityApi">
|
||||
<summary>
|
||||
Provides access to community data 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>
|
||||
Returns the list of all posts in blogs on the portal with the post title, date of creation and update, post text and author ID and display name
|
||||
</summary>
|
||||
<short>All posts</short>
|
||||
<returns>List of all posts</returns>
|
||||
<category>Blogs</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.CreatePost(System.String,System.String,System.String,System.Boolean)">
|
||||
<summary>
|
||||
Creates a blog post with the specified title, content, tags and subscription to comments defined in the request body
|
||||
</summary>
|
||||
<short>Create post</short>
|
||||
<param name="title">New post title</param>
|
||||
<param name="content">New post text</param>
|
||||
<param name="tags">Tag list separated with ','</param>
|
||||
<param name="subscribeComments">Subscribe to post comments</param>
|
||||
<returns>Newly created post</returns>
|
||||
<example>
|
||||
<![CDATA[Sending data in application/json:
|
||||
|
||||
{
|
||||
title:"My post",
|
||||
content:"Post content",
|
||||
tags:"Me,Post,News",
|
||||
subscribeComments: "true"
|
||||
}
|
||||
|
||||
Sending data in application/x-www-form-urlencoded
|
||||
title="My post"&content="Post content"&tags="Me,Post,News"&subscribeComments="true"]]>
|
||||
</example>
|
||||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
|
||||
<category>Blogs</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.UpdatePost(System.Guid,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Updates the specified post changing the post title, content or/and tags specified
|
||||
</summary>
|
||||
<short>Update post</short>
|
||||
<param name="postid">post ID</param>
|
||||
<param name="title">new title</param>
|
||||
<param name="content">new post text</param>
|
||||
<param name="tags">tag list separated with ','</param>
|
||||
<returns>Updated post</returns>
|
||||
<example>
|
||||
<![CDATA[
|
||||
Sending data in application/json:
|
||||
{
|
||||
title:"My post",
|
||||
content:"Post content",
|
||||
tags:"Me,Post,News"
|
||||
}
|
||||
|
||||
Sending data in application/x-www-form-urlencoded
|
||||
title="My post"&content="Post content"&tags="Me,Post,News"
|
||||
]]>
|
||||
|
||||
</example>
|
||||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
|
||||
<category>Blogs</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.DeletePost(System.Guid)">
|
||||
<summary>
|
||||
Deletes the selected post from blogs
|
||||
</summary>
|
||||
<short>Delete post</short>
|
||||
<param name="postid">post ID to delete</param>
|
||||
<returns>Nothing</returns>
|
||||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
|
||||
<category>Blogs</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetMyPosts">
|
||||
<summary>
|
||||
Returns the list of all blog posts for the current user with the post title, date of creation and update, post text and author ID and display name
|
||||
</summary>
|
||||
<category>Blogs</category>
|
||||
<short>My posts</short>
|
||||
<returns>My post list</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetSearchPosts(System.String)">
|
||||
<summary>
|
||||
Returns a list of blog posts matching the search query with the post title, date of creation and update, post text and author
|
||||
</summary>
|
||||
<category>Blogs</category>
|
||||
<short>
|
||||
Search posts
|
||||
</short>
|
||||
<param name="query">search query</param>
|
||||
<returns>Found post list</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetUserPosts(System.String)">
|
||||
<summary>
|
||||
Returns a list of blog posts of the specified user with the post title, date of creation and update and post text
|
||||
</summary>
|
||||
<short>User posts</short>
|
||||
<category>Blogs</category>
|
||||
<param name="username" remark="You can retrieve username through 'people' api">Username</param>
|
||||
<returns>List of user posts</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetPostsByTag(System.String)">
|
||||
<summary>
|
||||
Returns a list of blog posts containing the specified tag with the post title, date of creation and update, post text and author
|
||||
</summary>
|
||||
<short>By tag</short>
|
||||
<category>Blogs</category>
|
||||
<param name="tag">tag name</param>
|
||||
<returns>List of posts tagged with tag name</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetTags">
|
||||
<summary>
|
||||
Returns a list of all tags used with blog posts with the post title, date of creation and update, post text, author and all the tags used
|
||||
</summary>
|
||||
<category>Blogs</category>
|
||||
<short>Tags</short>
|
||||
<returns>List of tags</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetPost(System.Guid)">
|
||||
<summary>
|
||||
Returns the detailed information for the blog post with the ID specified in the request
|
||||
</summary>
|
||||
<short>Specific post</short>
|
||||
<category>Blogs</category>
|
||||
<param name="postid">post ID</param>
|
||||
<returns>post</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetComments(System.Guid)">
|
||||
<summary>
|
||||
Returns the list of all the comments for the blog post with the ID specified in the request
|
||||
</summary>
|
||||
<category>Blogs</category>
|
||||
<short>Get comments</short>
|
||||
<param name="postid">post ID (GUID)</param>
|
||||
<returns>list of post comments</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddComment(System.Guid,System.String,System.Guid)">
|
||||
<summary>
|
||||
Adds a comment to the specified post with the comment text specified. The parent comment ID can be also specified if needed.
|
||||
</summary>
|
||||
<short>Add comment</short>
|
||||
<category>Blogs</category>
|
||||
<param name="postid">post ID</param>
|
||||
<param name="content">comment text</param>
|
||||
<param name="parentId">parent comment ID</param>
|
||||
<returns>List of post comments</returns>
|
||||
<example>
|
||||
<![CDATA[
|
||||
Sending data in application/json:
|
||||
|
||||
{
|
||||
content:"My comment",
|
||||
parentId:"9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||||
}
|
||||
|
||||
Sending data in application/x-www-form-urlencoded
|
||||
content="My comment"&parentId="9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||||
]]>
|
||||
</example>
|
||||
<remarks>
|
||||
Send parentId=00000000-0000-0000-0000-000000000000 or don't send it at all if you want your comment to be on the root level
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetBlogCommentPreview(System.String,System.String)">
|
||||
<summary>
|
||||
Get comment preview with the content specified in the request
|
||||
</summary>
|
||||
<short>Get comment preview</short>
|
||||
<section>Comments</section>
|
||||
<param name="commentid">Comment ID</param>
|
||||
<param name="htmltext">Comment content</param>
|
||||
<returns>Comment info</returns>
|
||||
<category>Blogs</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.RemoveBlogComment(System.String)">
|
||||
<summary>
|
||||
Remove comment with the id specified in the request
|
||||
</summary>
|
||||
<short>Remove comment</short>
|
||||
<section>Comments</section>
|
||||
<param name="commentid">Comment ID</param>
|
||||
<returns>Comment id</returns>
|
||||
<category>Blogs</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddBlogComment(System.String,System.String,System.String)">
|
||||
<category>Blogs</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.UpdateBlogComment(System.String,System.String)">
|
||||
<category>Blogs</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarks">
|
||||
<summary>
|
||||
Returns the list of all bookmarks on the portal with the bookmark titles, date of creation and update, bookmark text and author
|
||||
</summary>
|
||||
<short>
|
||||
All bookmarks
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<returns>List of all bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetMyBookmarks">
|
||||
<summary>
|
||||
Returns the list of all bookmarks for the current user with the bookmark titles, date of creation and update, bookmark text and author
|
||||
</summary>
|
||||
<short>
|
||||
Added by me
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<returns>List of bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.SearchBookmarks(System.String)">
|
||||
<summary>
|
||||
Returns a list of bookmarks matching the search query with the bookmark title, date of creation and update, bookmark description and author
|
||||
</summary>
|
||||
<short>
|
||||
Search
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<param name="query">search query</param>
|
||||
<returns>List of bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetFavsBookmarks">
|
||||
<summary>
|
||||
Returns the list of favorite bookmarks for the current user with the bookmark titles, date of creation and update, bookmark text and author
|
||||
</summary>
|
||||
<short>
|
||||
My favorite
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<returns>List of bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarksTags">
|
||||
<summary>
|
||||
Returns a list of all tags used for bookmarks with the number showing the tag usage
|
||||
</summary>
|
||||
<short>
|
||||
All tags
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<returns>List of tags</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarksByTag(System.String)">
|
||||
<summary>
|
||||
Returns the list of all bookmarks marked by the tag specified with the bookmark titles, date of creation and update, bookmark text and author
|
||||
</summary>
|
||||
<short>
|
||||
By tag
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<param name="tag">tag</param>
|
||||
<returns>List of bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetRecentBookmarks">
|
||||
<summary>
|
||||
Returns the list of recenty added bookmarks with the bookmark titles, date of creation and update, bookmark text and author
|
||||
</summary>
|
||||
<short>
|
||||
Recently added
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<returns>List of bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetTopDayBookmarks">
|
||||
<summary>
|
||||
Returns the list of the bookmarks most popular on the current date with the bookmark titles, date of creation and update, bookmark text and author
|
||||
</summary>
|
||||
<short>
|
||||
Top of day
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<returns>List of bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetTopMonthBookmarks">
|
||||
<summary>
|
||||
Returns the list of the bookmarks most popular in the current month with the bookmark titles, date of creation and update, bookmark text and author
|
||||
</summary>
|
||||
<short>
|
||||
Top of month
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<returns>List of bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetTopWeekBookmarks">
|
||||
<summary>
|
||||
Returns the list of the bookmarks most popular on the current week with the bookmark titles, date of creation and update, bookmark text and author
|
||||
</summary>
|
||||
<short>
|
||||
Top of week
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<returns>list of bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetTopYearBookmarks">
|
||||
<summary>
|
||||
Returns the list of the bookmarks most popular in the current year with the bookmark titles, date of creation and update, bookmark text and author
|
||||
</summary>
|
||||
<short>
|
||||
Top of year
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<returns>list of bookmarks</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarkComments(System.Int64)">
|
||||
<summary>
|
||||
Returns the list of all comments to the bookmark with the specified ID
|
||||
</summary>
|
||||
<short>
|
||||
Get comments
|
||||
</short>
|
||||
<category>Bookmarks</category>
|
||||
<param name="id">Bookmark ID</param>
|
||||
<returns>list of bookmark comments</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddBookmarkComment(System.Int64,System.String,System.Guid)">
|
||||
<summary>
|
||||
Adds a comment to the bookmark with the specified ID. The parent bookmark ID can be also specified if needed.
|
||||
</summary>
|
||||
<short>
|
||||
Add comment
|
||||
</short>
|
||||
<param name="id">Bookmark ID</param>
|
||||
<param name="content">comment content</param>
|
||||
<param name="parentId">parent comment ID</param>
|
||||
<returns>list of bookmark comments</returns>
|
||||
<example>
|
||||
<![CDATA[
|
||||
Sending data in application/json:
|
||||
|
||||
{
|
||||
content:"My comment",
|
||||
parentId:"9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||||
}
|
||||
|
||||
Sending data in application/x-www-form-urlencoded
|
||||
content="My comment"&parentId="9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||||
]]>
|
||||
</example>
|
||||
<remarks>
|
||||
Send parentId=00000000-0000-0000-0000-000000000000 or don't send it at all if you want your comment to be on the root level
|
||||
</remarks>
|
||||
<category>Bookmarks</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarkById(System.Int64)">
|
||||
<summary>
|
||||
Returns a detailed information on the bookmark with the specified ID
|
||||
</summary>
|
||||
<short>
|
||||
Get bookmarks by ID
|
||||
</short>
|
||||
<param name="id">Bookmark ID</param>
|
||||
<returns>bookmark</returns>
|
||||
<category>Bookmarks</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddBookmark(System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Adds a bookmark with a specified title, description and tags
|
||||
</summary>
|
||||
<short>
|
||||
Add bookmark
|
||||
</short>
|
||||
<param name="url">url of bookmarking page</param>
|
||||
<param name="title">title to show</param>
|
||||
<param name="description">description</param>
|
||||
<param name="tags">tags. separated by semicolon</param>
|
||||
<returns>newly added bookmark</returns>
|
||||
<example>
|
||||
<![CDATA[
|
||||
Sending data in application/json:
|
||||
|
||||
{
|
||||
url:"www.teamlab.com",
|
||||
title: "TeamLab",
|
||||
description: "best site i've ever seen",
|
||||
tags: "project management, collaboration"
|
||||
}
|
||||
|
||||
Sending data in application/x-www-form-urlencoded
|
||||
url="www.teamlab.com"&title="TeamLab"&description="best site i've ever seen"&tags="project management, collaboration"
|
||||
]]>
|
||||
</example>
|
||||
<category>Bookmarks</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetBookmarkCommentPreview(System.String,System.String)">
|
||||
<summary>
|
||||
Get comment preview with the content specified in the request
|
||||
</summary>
|
||||
<short>Get comment preview</short>
|
||||
<section>Comments</section>
|
||||
<param name="commentid">Comment ID</param>
|
||||
<param name="htmltext">Comment content</param>
|
||||
<returns>Comment info</returns>
|
||||
<category>Bookmarks</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.RemoveBookmarkComment(System.String)">
|
||||
<summary>
|
||||
Remove comment with the id specified in the request
|
||||
</summary>
|
||||
<short>Remove comment</short>
|
||||
<section>Comments</section>
|
||||
<param name="commentid">Comment ID</param>
|
||||
<returns>Comment id</returns>
|
||||
<category>Bookmarks</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddBookmarkComment(System.String,System.Int64,System.String)">
|
||||
<category>Bookmarks</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.UpdateBookmarkComment(System.String,System.String)">
|
||||
<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
|
||||
</summary>
|
||||
<short>
|
||||
All events
|
||||
</short>
|
||||
<returns>list of events</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.CreateEvent(System.String,System.String,ASC.Web.Community.News.Code.FeedType)">
|
||||
<summary>
|
||||
Creates a new event with the parameters (title, content, type) specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Create event
|
||||
</short>
|
||||
<param name="title">Title</param>
|
||||
<param name="content">Content</param>
|
||||
<param name="type">Type. One of (News|Order|Advert|Poll)</param>
|
||||
<returns>New created event</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.UpdateEvent(System.Int32,System.String,System.String,ASC.Web.Community.News.Code.FeedType)">
|
||||
<summary>
|
||||
Updates the selected event changing the event title, content or/and event type specified
|
||||
</summary>
|
||||
<short>
|
||||
Update event
|
||||
</short>
|
||||
<param name="feedid">Feed ID</param>
|
||||
<param name="title">Title</param>
|
||||
<param name="content">Content</param>
|
||||
<param name="type">Type</param>
|
||||
<returns>List of events</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetMyEvents">
|
||||
<summary>
|
||||
Returns the list of all events for the current user with the event titles, date of creation and update, event text and author
|
||||
</summary>
|
||||
<short>
|
||||
My events
|
||||
</short>
|
||||
<returns>List of events</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.SearchEvents(System.String)">
|
||||
<summary>
|
||||
Returns a list of events matching the search query with the event title, date of creation and update, event type and author
|
||||
</summary>
|
||||
<short>
|
||||
Search
|
||||
</short>
|
||||
<param name="query">search query</param>
|
||||
<returns>List of events</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetEvent(System.Int32)">
|
||||
<summary>
|
||||
Returns the detailed information about the event with the specified ID
|
||||
</summary>
|
||||
<short>
|
||||
Specific event
|
||||
</short>
|
||||
<param name="feedid">Event ID</param>
|
||||
<returns>Event</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetEventComments(System.Int32)">
|
||||
<summary>
|
||||
Returns the detailed information about the comments on the event with the specified ID
|
||||
</summary>
|
||||
<short>
|
||||
Get comments
|
||||
</short>
|
||||
<param name="feedid">Event id</param>
|
||||
<returns>List of comments</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddEventComments(System.Int32,System.String,System.Int64)">
|
||||
<summary>
|
||||
Adds a comment to the event with the specified ID. The parent event ID can be also specified if needed.
|
||||
</summary>
|
||||
<short>
|
||||
Add comment
|
||||
</short>
|
||||
<param name="feedid">Event ID</param>
|
||||
<param name="content">Comment content</param>
|
||||
<param name="parentId">Comment parent ID</param>
|
||||
<returns>Comments list</returns>
|
||||
<example>
|
||||
<![CDATA[
|
||||
Sending data in application/json:
|
||||
|
||||
{
|
||||
content:"My comment",
|
||||
parentId:"9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||||
}
|
||||
|
||||
Sending data in application/x-www-form-urlencoded
|
||||
content="My comment"&parentId="9924256A-739C-462b-AF15-E652A3B1B6EB"
|
||||
]]>
|
||||
</example>
|
||||
<remarks>
|
||||
Send parentId=0 or don't send it at all if you want your comment to be on the root level
|
||||
</remarks>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.VoteForEvent(System.Int32,System.Int64[])">
|
||||
<summary>
|
||||
Sends a vote to a certain option in a poll-type event with the ID specified
|
||||
</summary>
|
||||
<short>
|
||||
Vote for event
|
||||
</short>
|
||||
<param name="feedid">Event ID</param>
|
||||
<param name="variants">Variants</param>
|
||||
<returns>Event</returns>
|
||||
<exception cref="T:System.ArgumentException">Thrown if not a Poll</exception>
|
||||
<exception cref="T:System.Exception">General error</exception>
|
||||
<example>
|
||||
<![CDATA[
|
||||
Sending data in application/json:
|
||||
{
|
||||
variants:[1,2,3],
|
||||
}
|
||||
Sending data in application/x-www-form-urlencoded
|
||||
variants=[1,2,3]
|
||||
]]>
|
||||
</example>
|
||||
<remarks>
|
||||
If event is not a poll, then you'll get an error
|
||||
</remarks>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.SubscribeOnComments(System.Boolean,System.String)">
|
||||
<summary>
|
||||
Subscribe or unsubscribe on comments of event with the ID specified
|
||||
</summary>
|
||||
<short>
|
||||
Subscribe/unsubscribe on comments
|
||||
</short>
|
||||
<param name="isSubscribe">is already subscribed or unsubscribed</param>
|
||||
<param name="feedid">Feed ID</param>
|
||||
<returns>Boolean value</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetEventCommentPreview(System.String,System.String)">
|
||||
<summary>
|
||||
Get comment preview with the content specified in the request
|
||||
</summary>
|
||||
<short>Get comment preview</short>
|
||||
<section>Comments</section>
|
||||
<param name="commentid">Comment ID</param>
|
||||
<param name="htmltext">Comment content</param>
|
||||
<returns>Comment info</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.RemoveEventComment(System.String)">
|
||||
<summary>
|
||||
Remove comment with the id specified in the request
|
||||
</summary>
|
||||
<short>Remove comment</short>
|
||||
<section>Comments</section>
|
||||
<param name="commentid">Comment ID</param>
|
||||
<returns>Comment info</returns>
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddEventComment(System.String,System.String,System.String)">
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.UpdateComment(System.String,System.String)">
|
||||
<category>Events</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetForums">
|
||||
<summary>
|
||||
Returns the list of all forums created on the portal with the topic/thread titles, date of creation and update, post text and author ID and display name
|
||||
</summary>
|
||||
<short>
|
||||
Forum list
|
||||
</short>
|
||||
<returns>List of forums</returns>
|
||||
<category>Forums</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetForumsCount">
|
||||
<summary>
|
||||
Returns the number of all forums created on the portal
|
||||
</summary>
|
||||
<short>
|
||||
Forums count
|
||||
</short>
|
||||
<returns>Number of forums</returns>
|
||||
<visible>false</visible>
|
||||
<category>Forums</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetThreadTopics(System.Int32)">
|
||||
<summary>
|
||||
Returns the list of all thread topics in the forums on the portal with the thread title, date of creation and update, post text and author id and display name
|
||||
</summary>
|
||||
<short>
|
||||
Thread topics
|
||||
</short>
|
||||
<param name="threadid">Thread ID</param>
|
||||
<returns>List of topics in thread</returns>
|
||||
<category>Forums</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetLastTopics">
|
||||
<summary>
|
||||
Returns the list of all recently updated topics in the forums on the portal with the topic title, date of creation and update, post text and author
|
||||
</summary>
|
||||
<short>
|
||||
Last updated topics
|
||||
</short>
|
||||
<returns></returns>
|
||||
<category>Forums</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetTopicPosts(System.Int32)">
|
||||
<summary>
|
||||
Returns the list of all posts in a selected thread in the forums on the portal with the thread title, date of creation and update, post text and author ID and display name
|
||||
</summary>
|
||||
<short>
|
||||
Posts
|
||||
</short>
|
||||
<param name="topicid">Topic ID</param>
|
||||
<returns>List of posts in topic</returns>
|
||||
<category>Forums</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddThreadToCategory(System.Int32,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Add thread to category
|
||||
</summary>
|
||||
<short>
|
||||
Add thread to category
|
||||
</short>
|
||||
<param name="categoryId">Category ID (-1 for new category)</param>
|
||||
<param name="categoryName">Category name</param>
|
||||
<param name="threadName">Thread name</param>
|
||||
<param name="threadDescription">Thread description</param>
|
||||
<returns>Added thread</returns>
|
||||
<category>Forums</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddTopic(System.Int32,System.String,System.String,ASC.Forum.TopicType)">
|
||||
<summary>
|
||||
Adds a new topic to an existing thread with a subject, content and topic type specified
|
||||
</summary>
|
||||
<short>
|
||||
Add topic to thread
|
||||
</short>
|
||||
<param name="subject">Topic subject</param>
|
||||
<param name="threadid">ID of thread to add to</param>
|
||||
<param name="content">Topic text</param>
|
||||
<param name="topicType">Type of topic</param>
|
||||
<returns>Added topic</returns>
|
||||
<category>Forums</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.UpdateTopic(System.Int32,System.String,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Updates a topic in an existing thread changing the thread subject, making it sticky or closing it
|
||||
</summary>
|
||||
<short>
|
||||
Update topic in thread
|
||||
</short>
|
||||
<param name="topicid">ID of topic to update</param>
|
||||
<param name="subject">Subject</param>
|
||||
<param name="sticky">Is sticky</param>
|
||||
<param name="closed">Close topic</param>
|
||||
<returns>Updated topic</returns>
|
||||
<category>Forums</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.AddTopicPosts(System.Int32,System.Int32,System.String,System.String)">
|
||||
<summary>
|
||||
Adds a post to an existing topic with a post subject and content specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Add post to topic
|
||||
</short>
|
||||
<param name="topicid">Topic ID</param>
|
||||
<param name="parentPostId">Parent post ID</param>
|
||||
<param name="subject">Post subject (required)</param>
|
||||
<param name="content">Post text</param>
|
||||
<returns>New post</returns>
|
||||
<category>Forums</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.UpdateTopicPosts(System.Int32,System.Int32,System.String,System.String)">
|
||||
<summary>
|
||||
Updates a post in an existing topic changing the post subject or/and content
|
||||
</summary>
|
||||
<short>
|
||||
Update post in topic
|
||||
</short>
|
||||
<param name="topicid">Topic ID</param>
|
||||
<param name="postid">ID of post to update</param>
|
||||
<param name="subject">Post subject (required)</param>
|
||||
<param name="content">Post text</param>
|
||||
<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
|
||||
</summary>
|
||||
<short>
|
||||
Search
|
||||
</short>
|
||||
<param name="query">Search query</param>
|
||||
<returns>list of topics</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
|
||||
</summary>
|
||||
<short>Subscribe/unsubscribe on birthday</short>
|
||||
<param name="userid">user ID</param>
|
||||
<param name="onRemind">should be subscribed or unsubscribed</param>
|
||||
<returns>onRemind value</returns>
|
||||
<category>Birthday</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.CreatePage(System.String,System.String)">
|
||||
<summary>
|
||||
Creates a new wiki page with the page name and content specified in the request
|
||||
</summary>
|
||||
<short>Create page</short>
|
||||
<param name="name">Page name</param>
|
||||
<param name="body">Page content</param>
|
||||
<returns>page info</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetPages(System.String)">
|
||||
<summary>
|
||||
Returns the list of all pages in wiki or pages in wiki category specified in the request
|
||||
</summary>
|
||||
<short>Pages</short>
|
||||
<section>Pages</section>
|
||||
<param name="category">Category name</param>
|
||||
<returns></returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetPage(System.String,System.Nullable{System.Int32})">
|
||||
<summary>
|
||||
Return the detailed information about the wiki page with the name and version specified in the request
|
||||
</summary>
|
||||
<short>Page</short>
|
||||
<section>Pages</section>
|
||||
<param name="name">Page name</param>
|
||||
<param name="version">Page version</param>
|
||||
<returns>Page info</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetHistory(System.String)">
|
||||
<summary>
|
||||
Returns the list of history changes for the wiki page with the name specified in the request
|
||||
</summary>
|
||||
<short>History</short>
|
||||
<section>Pages</section>
|
||||
<param name="page">Page name</param>
|
||||
<returns>List of pages</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.SearchPages(System.String)">
|
||||
<summary>
|
||||
Returns the list of wiki pages with the name matching the search query specified in the request
|
||||
</summary>
|
||||
<short>Search</short>
|
||||
<section>Pages</section>
|
||||
<param name="name">Part of the page name</param>
|
||||
<returns>List of pages</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.SearchPagesByContent(System.String)">
|
||||
<summary>
|
||||
Returns the list of wiki pages with the content matching the search query specified in the request
|
||||
</summary>
|
||||
<short>Search</short>
|
||||
<section>Pages</section>
|
||||
<param name="content">Part of the page content</param>
|
||||
<returns>List of pages</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.UpdatePage(System.String,System.String)">
|
||||
<summary>
|
||||
Updates the wiki page with the name and content specified in the request
|
||||
</summary>
|
||||
<short>Update page</short>
|
||||
<section>Pages</section>
|
||||
<param name="name">Page name</param>
|
||||
<param name="body">Page content</param>
|
||||
<returns>Page info</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.DeletePage(System.String)">
|
||||
<summary>
|
||||
Deletes the wiki page with the name specified in the request
|
||||
</summary>
|
||||
<short>Delete page</short>
|
||||
<section>Pages</section>
|
||||
<param name="name">Page name</param>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.CreateComment(System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Creates the comment to the selected wiki page with the content specified in the request
|
||||
</summary>
|
||||
<short>Create comment</short>
|
||||
<section>Comments</section>
|
||||
<param name="page">Page name</param>
|
||||
<param name="content">Comment content</param>
|
||||
<param name="parentId">Comment parent id</param>
|
||||
<returns>Comment info</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetComments(System.String)">
|
||||
<summary>
|
||||
Returns the list of all comments to the wiki page with the name specified in the request
|
||||
</summary>
|
||||
<short>All comments</short>
|
||||
<section>Comments</section>
|
||||
<param name="page">Page name</param>
|
||||
<returns>List of comments</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.UploadFiles(System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
|
||||
<summary>
|
||||
Uploads the selected files to the wiki 'Files' section
|
||||
</summary>
|
||||
<short>Upload files</short>
|
||||
<param name="files">List of files to upload</param>
|
||||
<returns>List of files</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetFile(System.String)">
|
||||
<summary>
|
||||
Returns the detailed file info about the file with the specified name in the wiki 'Files' section
|
||||
</summary>
|
||||
<short>File</short>
|
||||
<section>Files</section>
|
||||
<param name="name">File name</param>
|
||||
<returns>File info</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.DeleteFile(System.String)">
|
||||
<summary>
|
||||
Deletes the files with the specified name from the wiki 'Files' section
|
||||
</summary>
|
||||
<short>Delete file</short>
|
||||
<param name="name">File name</param>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.GetWikiCommentPreview(System.String,System.String)">
|
||||
<summary>
|
||||
Get comment preview with the content specified in the request
|
||||
</summary>
|
||||
<short>Get comment preview</short>
|
||||
<section>Comments</section>
|
||||
<param name="commentid">Comment ID</param>
|
||||
<param name="htmltext">Comment content</param>
|
||||
<returns>Comment info</returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Community.CommunityApi.RemoveWikiComment(System.String)">
|
||||
<summary>
|
||||
Remove comment with the id specified in the request
|
||||
</summary>
|
||||
<short>Remove comment</short>
|
||||
<section>Comments</section>
|
||||
<param name="commentid">Comment ID</param>
|
||||
<returns>Comment info</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>
|
||||
Updates the comment to the selected wiki page with the comment content specified in the request
|
||||
</summary>
|
||||
<short>Update comment</short>
|
||||
<section>Comments</section>
|
||||
<param name="commentid">Comment ID</param>
|
||||
<param name="content">Comment content</param>
|
||||
<returns></returns>
|
||||
<category>Wiki</category>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Community.CommunityApi.Name">
|
||||
<summary>
|
||||
Starting entry point name
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Documents.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Documents.dll
Normal file
Binary file not shown.
1080
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Documents.xml
Normal file
1080
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Documents.xml
Normal file
File diff suppressed because it is too large
Load Diff
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Employee.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Employee.dll
Normal file
Binary file not shown.
512
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Employee.xml
Normal file
512
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Employee.xml
Normal file
@ -0,0 +1,512 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Employee</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:ASC.Api.Employee.EmployeeApi">
|
||||
<summary>
|
||||
User profiles access
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetMe">
|
||||
<summary>
|
||||
Returns the detailed information about the current user profile
|
||||
</summary>
|
||||
<short>
|
||||
My profile
|
||||
</short>
|
||||
<returns>Profile</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetAll">
|
||||
<summary>
|
||||
Returns the list of profiles for all portal users
|
||||
</summary>
|
||||
<short>
|
||||
All profiles
|
||||
</short>
|
||||
<returns>List of profiles</returns>
|
||||
<remarks>This method returns a partial profile. Use more specific method to get full profile</remarks>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetById(System.String)">
|
||||
<summary>
|
||||
Returns the detailed information about the profile of the user with the name specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Specific profile
|
||||
</short>
|
||||
<param name="username">User name</param>
|
||||
<returns>User profile</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetByEmail(System.String)">
|
||||
<summary>
|
||||
Returns the detailed information about the profile of the user with the name specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Specific profile
|
||||
</short>
|
||||
<param name="email">User email</param>
|
||||
<returns>User profile</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetSearch(System.String)">
|
||||
<summary>
|
||||
Returns the list of profiles for all portal users matching the search query
|
||||
</summary>
|
||||
<short>
|
||||
Search users
|
||||
</short>
|
||||
<param name="query">Query</param>
|
||||
<returns>List of users</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetPeopleSearch(System.String)">
|
||||
<summary>
|
||||
Returns the list of users matching the search criteria
|
||||
</summary>
|
||||
<short>
|
||||
User search
|
||||
</short>
|
||||
<param name="query">Search text</param>
|
||||
<returns>User list</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetAdvanced(ASC.Core.Users.EmployeeStatus,System.String)">
|
||||
<summary>
|
||||
Returns the list of users matching the status filter and text search
|
||||
</summary>
|
||||
<short>
|
||||
User search by filter
|
||||
</short>
|
||||
<param name="status">User status</param>
|
||||
<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})">
|
||||
<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)">
|
||||
<summary>
|
||||
Adds a new portal user with the first and last name, email address and several optional parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Add new user
|
||||
</short>
|
||||
<param name="isVisitor">User or Visitor (bool type: false|true)</param>
|
||||
<param name="email">Email</param>
|
||||
<param name="firstname">First name</param>
|
||||
<param name="lastname">Last name</param>
|
||||
<param name="department" optional="true">Department</param>
|
||||
<param name="title" optional="true">Title</param>
|
||||
<param name="location" optional="true">Location</param>
|
||||
<param name="sex" optional="true">Sex (male|female)</param>
|
||||
<param name="birthday" optional="true">Birthday</param>
|
||||
<param name="worksfrom" optional="true">Works from date. If not specified - current will be set</param>
|
||||
<param name="comment" optional="true">Comment for user</param>
|
||||
<param name="contacts">List of contacts</param>
|
||||
<param name="files">Avatar photo url</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)">
|
||||
<summary>
|
||||
Adds a new portal user with the first and last name, email address and several optional parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Add new user
|
||||
</short>
|
||||
<param name="isVisitor">User or Visitor (bool type: false|true)</param>
|
||||
<param name="email">Email</param>
|
||||
<param name="firstname">First name</param>
|
||||
<param name="lastname">Last name</param>
|
||||
<param name="department" optional="true">Department</param>
|
||||
<param name="title" optional="true">Title</param>
|
||||
<param name="location" optional="true">Location</param>
|
||||
<param name="sex" optional="true">Sex (male|female)</param>
|
||||
<param name="birthday" optional="true">Birthday</param>
|
||||
<param name="worksfrom" optional="true">Works from date. If not specified - current will be set</param>
|
||||
<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">User Password</param>
|
||||
<returns>Newly created user</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMember(System.Boolean,System.String,System.String,System.String,System.String,System.Guid[],System.String,System.String,System.String,ASC.Specific.ApiDateTime,ASC.Specific.ApiDateTime,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact},System.String,System.Nullable{System.Boolean})">
|
||||
<summary>
|
||||
Updates the data for the selected portal user with the first and last name, email address and/or optional parameters specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Update user
|
||||
</short>
|
||||
<param name="isVisitor">User or Visitor (bool type: false|true)</param>
|
||||
<param name="userid">User ID to update</param>
|
||||
<param name="firstname">First name</param>
|
||||
<param name="lastname">Last name</param>
|
||||
<param name="comment" optional="true">Comment for user</param>
|
||||
<param name="department" optional="true">Department</param>
|
||||
<param name="title" optional="true">Title</param>
|
||||
<param name="location" optional="true">Location</param>
|
||||
<param name="sex" optional="true">Sex (male|female)</param>
|
||||
<param name="birthday" optional="true">Birthday</param>
|
||||
<param name="worksfrom" optional="true">Works from date. If not specified - current will be set</param>
|
||||
<param name="contacts">List fo contacts</param>
|
||||
<param name="files">Avatar photo url</param>
|
||||
<param name="disable"></param>
|
||||
<returns>Newly created user</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.DeleteMember(System.String)">
|
||||
<summary>
|
||||
Deletes the user with the ID specified in the request from the portal
|
||||
</summary>
|
||||
<short>
|
||||
Delete user
|
||||
</short>
|
||||
<param name="userid">ID of user to delete</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMemberContacts(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact})">
|
||||
<summary>
|
||||
Updates the specified user contact information merging the sent data with the present on the portal
|
||||
</summary>
|
||||
<short>
|
||||
Update user contacts
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="contacts">Contacts list</param>
|
||||
<returns>Updated user profile</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.SetMemberContacts(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact})">
|
||||
<summary>
|
||||
Updates the specified user contact information changing the data present on the portal for the sent data
|
||||
</summary>
|
||||
<short>
|
||||
Set user contacts
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="contacts">Contacts list</param>
|
||||
<returns>Updated user profile</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.DeleteMemberContacts(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Employee.Contact})">
|
||||
<summary>
|
||||
Updates the specified user contact information deleting the data specified in the request from the portal
|
||||
</summary>
|
||||
<short>
|
||||
Delete user contacts
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="contacts">Contacts list</param>
|
||||
<returns>Updated user profile</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateMemberPhoto(System.String,System.String)">
|
||||
<summary>
|
||||
Updates the specified user photo with the pathname
|
||||
</summary>
|
||||
<short>
|
||||
Update user photo
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="files">Avatar photo url</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.DeleteMemberPhoto(System.String)">
|
||||
<summary>
|
||||
Deletes the photo of the user with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Delete user photo
|
||||
</short>
|
||||
<param name="userid">User ID</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
|
||||
</summary>
|
||||
<short>
|
||||
Remind user password
|
||||
</short>
|
||||
<param name="email">User email</param>
|
||||
<returns></returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.ChangeUserPassword(System.Guid,System.String,System.String)">
|
||||
<summary>
|
||||
Sets the password and email for the user with the ID specified in the request
|
||||
</summary>
|
||||
<param name="userid">User ID</param>
|
||||
<param name="password">Password</param>
|
||||
<param name="email">New email</param>
|
||||
<returns>Detailed user information</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateEmployeeActivationStatus(ASC.Core.Users.EmployeeActivationStatus,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Sets the required activation status to the list of users with the ID specified in the request
|
||||
</summary>
|
||||
<summary>
|
||||
Set activation status
|
||||
</summary>
|
||||
<param name="userIds">User list ID</param>
|
||||
<param name="activationstatus">Required status</param>
|
||||
<returns>List of users</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateUserType(ASC.Core.Users.EmployeeType,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Changes the type between user and guest for the user with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
User type change
|
||||
</short>
|
||||
<param name="type">New user type</param>
|
||||
<param name="userIds">User ID list</param>
|
||||
<returns>User list</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UpdateUserStatus(ASC.Core.Users.EmployeeStatus,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Changes the status between active and disabled for the user with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
User status change
|
||||
</short>
|
||||
<param name="status">New user status</param>
|
||||
<param name="userIds">User ID list</param>
|
||||
<returns>User list</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.ResendUserInvites(System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Sends emails once again for the users who have not activated their emails
|
||||
</summary>
|
||||
<short>
|
||||
Send activation email
|
||||
</short>
|
||||
<param name="userIds">User ID list</param>
|
||||
<returns>User list</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.RemoveUsers(System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Delete the list of selected users
|
||||
</summary>
|
||||
<short>
|
||||
Delete users
|
||||
</short>
|
||||
<param name="userIds">User ID list</param>
|
||||
<returns>User list</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.SendInstructionsToDelete">
|
||||
<summary>
|
||||
Send instructions for delete user own profile
|
||||
</summary>
|
||||
<short>
|
||||
Send delete instructions
|
||||
</short>
|
||||
<returns>Info message</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.JoinToAffiliateProgram">
|
||||
<summary>
|
||||
Join to affiliate programm
|
||||
</summary>
|
||||
<short>
|
||||
Join to affiliate programm
|
||||
</short>
|
||||
<returns>Link to affiliate programm</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.LinkAccount(System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.UnlinkAccount(System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetReassignProgress(System.Guid)">
|
||||
<summary>
|
||||
Returns the progress of the started reassign process
|
||||
</summary>
|
||||
<param name="userId">User ID whose data is reassigned</param>
|
||||
<category>Reassign user data</category>
|
||||
<returns>Reassign Progress</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.TerminateReassign(System.Guid)">
|
||||
<summary>
|
||||
Terminate reassign process
|
||||
</summary>
|
||||
<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)">
|
||||
<summary>
|
||||
Start a reassign process
|
||||
</summary>
|
||||
<param name="fromUserId">From User ID</param>
|
||||
<param name="toUserId">To User ID</param>
|
||||
<category>Reassign user data</category>
|
||||
<returns>Reassign Progress</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.GetRemoveProgress(System.Guid)">
|
||||
<summary>
|
||||
Returns the progress of the started remove process
|
||||
</summary>
|
||||
<param name="userId">User ID</param>
|
||||
<category>Remove user data</category>
|
||||
<returns>Remove Progress</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.TerminateRemove(System.Guid)">
|
||||
<summary>
|
||||
Terminate remove process
|
||||
</summary>
|
||||
<param name="userId">User ID</param>
|
||||
<category>Remove user data</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.EmployeeApi.StartRemove(System.Guid)">
|
||||
<summary>
|
||||
Start a remove process
|
||||
</summary>
|
||||
<param name="userId">User ID</param>
|
||||
<category>Remove user data</category>
|
||||
<returns>Remove Progress</returns>
|
||||
</member>
|
||||
<member name="T:ASC.Api.Employee.GroupsApi">
|
||||
<summary>
|
||||
Groups access
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.GetAll">
|
||||
<summary>
|
||||
Returns the general information about all groups, such as group ID and group manager
|
||||
</summary>
|
||||
<short>
|
||||
All groups
|
||||
</short>
|
||||
<returns>List of groups</returns>
|
||||
<remarks>
|
||||
This method returns partial group info
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.GetById(System.Guid)">
|
||||
<summary>
|
||||
Returns the detailed information about the selected group: group name, category, description, manager, users and parent group if any
|
||||
</summary>
|
||||
<short>
|
||||
Specific group
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<returns>Group</returns>
|
||||
<remarks>
|
||||
That method returns full group info
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.GetByUserId(System.Guid)">
|
||||
<summary>
|
||||
Returns the group list for user
|
||||
</summary>
|
||||
<short>
|
||||
User groups
|
||||
</short>
|
||||
<param name="userid">User ID</param>
|
||||
<returns>Group</returns>
|
||||
<remarks>
|
||||
That method returns user groups
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.AddGroup(System.Guid,System.String,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Adds a new group with the group manager, name and users specified
|
||||
</summary>
|
||||
<short>
|
||||
Add new group
|
||||
</short>
|
||||
<param name="groupManager">Group manager</param>
|
||||
<param name="groupName">Group name</param>
|
||||
<param name="members">List of group users</param>
|
||||
<returns>Newly created group</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.UpdateGroup(System.Guid,System.Guid,System.String,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Updates an existing group changing the group manager, name and/or users
|
||||
</summary>
|
||||
<short>
|
||||
Update existing group
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="groupManager">Group manager</param>
|
||||
<param name="groupName">Group name</param>
|
||||
<param name="members">List of group users</param>
|
||||
<returns>Newly created group</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.DeleteGroup(System.Guid)">
|
||||
<summary>
|
||||
Deletes the selected group from the list of groups on the portal
|
||||
</summary>
|
||||
<short>
|
||||
Delete group
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.TransferMembersTo(System.Guid,System.Guid)">
|
||||
<summary>
|
||||
Move all the users from the selected group to another one specified
|
||||
</summary>
|
||||
<short>
|
||||
Move group users
|
||||
</short>
|
||||
<param name="groupid">ID of group to move from</param>
|
||||
<param name="newgroupid">ID of group to move to</param>
|
||||
<returns>Group info which users were moved</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.SetMembersTo(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Manages the group users deleting the current users and setting new ones instead
|
||||
</summary>
|
||||
<short>
|
||||
Set group users
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="members">User list</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.AddMembersTo(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Add new group users keeping the current users and adding new ones
|
||||
</summary>
|
||||
<short>
|
||||
Add group users
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="members">User list</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.SetManager(System.Guid,System.Guid)">
|
||||
<summary>
|
||||
Sets the user with the ID sent as a manager to the selected group
|
||||
</summary>
|
||||
<short>
|
||||
Set group manager
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="userid">User ID to become manager</param>
|
||||
<returns></returns>
|
||||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException"></exception>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Employee.GroupsApi.RemoveMembersFrom(System.Guid,System.Collections.Generic.IEnumerable{System.Guid})">
|
||||
<summary>
|
||||
Removes the specified group users with all the rest current group users retained
|
||||
</summary>
|
||||
<short>
|
||||
Remove group users
|
||||
</short>
|
||||
<param name="groupid">Group ID</param>
|
||||
<param name="members">User list</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
8
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Feed.XML
Normal file
8
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Feed.XML
Normal file
@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Feed</name>
|
||||
</assembly>
|
||||
<members>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Feed.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Feed.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Mail.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Mail.dll
Normal file
Binary file not shown.
1177
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Mail.xml
Normal file
1177
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Mail.xml
Normal file
File diff suppressed because it is too large
Load Diff
235
helpcenter.r7-office.ru/Web/Bin/ASC.Api.MailServer.XML
Normal file
235
helpcenter.r7-office.ru/Web/Bin/ASC.Api.MailServer.XML
Normal file
@ -0,0 +1,235 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.MailServer</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.CreateMailbox(System.String,System.String,System.Int32,System.String)">
|
||||
<summary>
|
||||
Create mailbox
|
||||
</summary>
|
||||
<param name="name"></param>
|
||||
<param name="local_part"></param>
|
||||
<param name="domain_id"></param>
|
||||
<param name="user_id"></param>
|
||||
<returns>MailboxData associated with tenant</returns>
|
||||
<short>Create mailbox</short>
|
||||
<category>Mailboxes</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.CreateMyMailbox(System.String)">
|
||||
<summary>
|
||||
Create my mailbox
|
||||
</summary>
|
||||
<param name="name"></param>
|
||||
<returns>MailboxData associated with tenant</returns>
|
||||
<short>Create mailbox</short>
|
||||
<category>Mailboxes</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetMailboxes">
|
||||
<summary>
|
||||
Returns list of the mailboxes associated with tenant
|
||||
</summary>
|
||||
<returns>List of MailboxData for current tenant</returns>
|
||||
<short>Get mailboxes list</short>
|
||||
<category>Mailboxes</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailbox(System.Int32)">
|
||||
<summary>
|
||||
Deletes the selected mailbox
|
||||
</summary>
|
||||
<param name="id">id of mailbox</param>
|
||||
<returns>MailOperationResult object</returns>
|
||||
<exception cref="T:System.ArgumentException">Exception happens when some parameters are invalid. Text description contains parameter name and text description.</exception>
|
||||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException">Exception happens when mailbox wasn't found.</exception>
|
||||
<short>Remove mailbox from mail server</short>
|
||||
<category>Mailboxes</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.UpdateMailbox(System.Int32,System.String)">
|
||||
<summary>
|
||||
Update mailbox
|
||||
</summary>
|
||||
<param name="mailbox_id">id of mailbox</param>
|
||||
<param name="name">sender name</param>
|
||||
<returns>Updated MailboxData</returns>
|
||||
<short>Update mailbox</short>
|
||||
<category>Mailboxes</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.AddMailboxAlias(System.Int32,System.String)">
|
||||
<summary>
|
||||
Add alias to mailbox
|
||||
</summary>
|
||||
<param name="mailbox_id">id of mailbox</param>
|
||||
<param name="alias_name">name of alias</param>
|
||||
<returns>MailboxData associated with tenant</returns>
|
||||
<short>Add mailbox's aliases</short>
|
||||
<category>AddressData</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailboxAlias(System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Remove alias from mailbox
|
||||
</summary>
|
||||
<param name="mailbox_id">id of mailbox</param>
|
||||
<param name="address_id"></param>
|
||||
<returns>id of mailbox</returns>
|
||||
<short>Remove mailbox's aliases</short>
|
||||
<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
|
||||
</summary>
|
||||
<param name="name"></param>
|
||||
<param name="domain_id"></param>
|
||||
<param name="address_ids"></param>
|
||||
<returns>MailGroupData associated with tenant</returns>
|
||||
<short>Create mail group address</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.AddMailGroupAddress(System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Add addresses to group
|
||||
</summary>
|
||||
<param name="mailgroup_id">id of group address</param>
|
||||
<param name="address_id"></param>
|
||||
<returns>MailGroupData associated with tenant</returns>
|
||||
<short>Add group's addresses</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailGroupAddress(System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Remove address from group
|
||||
</summary>
|
||||
<param name="mailgroup_id">id of group address</param>
|
||||
<param name="address_id"></param>
|
||||
<returns>id of group address</returns>
|
||||
<short>Remove group's address</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetMailGroups">
|
||||
<summary>
|
||||
Returns list of group addresses associated with tenant
|
||||
</summary>
|
||||
<returns>List of MailGroupData for current tenant</returns>
|
||||
<short>Get mail group list</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailGroup(System.Int32)">
|
||||
<summary>
|
||||
Deletes the selected group address
|
||||
</summary>
|
||||
<param name="id">id of group address</param>
|
||||
<returns>id of group address</returns>
|
||||
<short>Remove group address from mail server</short>
|
||||
<category>MailGroup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.CreateNotificationAddress(System.String,System.String,System.Int32)">
|
||||
<summary>
|
||||
Create address for tenant notifications
|
||||
</summary>
|
||||
<param name="name"></param>
|
||||
<param name="password"></param>
|
||||
<param name="domain_id"></param>
|
||||
<returns>NotificationAddressData associated with tenant</returns>
|
||||
<short>Create notification address</short>
|
||||
<category>Notifications</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveNotificationAddress(System.String)">
|
||||
<summary>
|
||||
Deletes address for notification
|
||||
</summary>
|
||||
<short>Remove mailbox from mail server</short>
|
||||
<category>Notifications</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetMailServer">
|
||||
<summary>
|
||||
Returns ServerData for mail server associated with tenant
|
||||
</summary>
|
||||
<returns>ServerData for current tenant.</returns>
|
||||
<short>Get mail server</short>
|
||||
<category>Servers</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetMailServerFullInfo">
|
||||
<summary>
|
||||
Returns ServerData for mail server associated with tenant
|
||||
</summary>
|
||||
<returns>ServerData for current tenant.</returns>
|
||||
<short>Get mail server</short>
|
||||
<category>Servers</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetUnusedDnsRecords">
|
||||
<summary>
|
||||
Get or generate free to any domain DNS records
|
||||
</summary>
|
||||
<returns>DNS records for current tenant and user.</returns>
|
||||
<short>Get free DNS records</short>
|
||||
<category>DnsRecords</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetDomains">
|
||||
<summary>
|
||||
Returns list of the web domains associated with tenant
|
||||
</summary>
|
||||
<returns>List of WebDomainData for current tenant</returns>
|
||||
<short>Get tenant web domain list</short>
|
||||
<category>Domains</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetCommonDomain">
|
||||
<summary>
|
||||
Returns the common web domain
|
||||
</summary>
|
||||
<returns>WebDomainData for common web domain</returns>
|
||||
<short>Get common web domain</short>
|
||||
<category>Domains</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.AddDomain(System.String,System.Int32)">
|
||||
<summary>
|
||||
Associate a web domain with tenant
|
||||
</summary>
|
||||
<param name="name">web domain name</param>
|
||||
<param name="id_dns"></param>
|
||||
<returns>WebDomainData associated with tenant</returns>
|
||||
<short>Add domain to mail server</short>
|
||||
<category>Domains</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.RemoveDomain(System.Int32)">
|
||||
<summary>
|
||||
Deletes the selected web domain
|
||||
</summary>
|
||||
<param name="id">id of web domain</param>
|
||||
<returns>id of web domain</returns>
|
||||
<short>Remove domain from mail server</short>
|
||||
<category>Domains</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.GetDnsRecords(System.Int32)">
|
||||
<summary>
|
||||
Returns dns records associated with domain
|
||||
</summary>
|
||||
<param name="id">id of domain</param>
|
||||
<returns>Dns records associated with domain</returns>
|
||||
<short>Returns dns records</short>
|
||||
<category>DnsRecords</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.IsDomainExists(System.String)">
|
||||
<summary>
|
||||
Check web domain name existance
|
||||
</summary>
|
||||
<param name="name">web domain name</param>
|
||||
<returns>True if domain name already exists.</returns>
|
||||
<short>Is domain name exists.</short>
|
||||
<category>Domains</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.MailServer.MailServerApi.CheckDomainOwnership(System.String)">
|
||||
<summary>
|
||||
Check web domain name ownership over txt record in dns
|
||||
</summary>
|
||||
<param name="name">web domain name</param>
|
||||
<returns>True if user is owner of this domain.</returns>
|
||||
<short>Check domain ownership.</short>
|
||||
<category>Domains</category>
|
||||
</member>
|
||||
<member name="P:ASC.Api.MailServer.MailServerApi.Name">
|
||||
<summary>
|
||||
Api name entry
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.MailServer.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.MailServer.dll
Normal file
Binary file not shown.
259
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Portal.XML
Normal file
259
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Portal.XML
Normal file
@ -0,0 +1,259 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Portal</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:ASC.Api.Portal.PortalApi">
|
||||
<summary>
|
||||
Portal info access
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.Get">
|
||||
<summary>
|
||||
Returns the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Current portal
|
||||
</short>
|
||||
<returns>Portal</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetUser(System.Guid)">
|
||||
<summary>
|
||||
Returns the user with specified userID from the current portal
|
||||
</summary>
|
||||
<short>
|
||||
User with specified userID
|
||||
</short>
|
||||
<category>Users</category>
|
||||
<returns>User</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GeInviteLink(ASC.Core.Users.EmployeeType)">
|
||||
<summary>
|
||||
Returns invitational link to the portal
|
||||
</summary>
|
||||
<short>
|
||||
Returns invitational link to the portal
|
||||
</short>
|
||||
<param name="employeeType">
|
||||
User or Visitor
|
||||
</param>
|
||||
<category>Users</category>
|
||||
<returns>
|
||||
Invite link
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetShortenLink(System.String)">
|
||||
<summary>
|
||||
Returns shorten link
|
||||
</summary>
|
||||
<param name="link">Link for shortening</param>
|
||||
<returns>link</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetUsedSpace">
|
||||
<summary>
|
||||
Returns the used space of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Used space of the current portal
|
||||
</short>
|
||||
<category>Quota</category>
|
||||
<returns>Used space</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetUsersCount">
|
||||
<summary>
|
||||
Returns the users count of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Users count of the current portal
|
||||
</short>
|
||||
<category>Users</category>
|
||||
<returns>Users count</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetTariff">
|
||||
<summary>
|
||||
Returns the current tariff of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Tariff of the current portal
|
||||
</short>
|
||||
<category>Quota</category>
|
||||
<returns>Tariff</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetQuota">
|
||||
<summary>
|
||||
Returns the current quota of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Quota of the current portal
|
||||
</short>
|
||||
<category>Quota</category>
|
||||
<returns>Quota</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetRightQuota">
|
||||
<summary>
|
||||
Returns the recommended quota of the current portal
|
||||
</summary>
|
||||
<short>
|
||||
Quota of the current portal
|
||||
</short>
|
||||
<category>Quota</category>
|
||||
<returns>Quota</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetFullAbsolutePath(System.String)">
|
||||
<summary>
|
||||
Returns path
|
||||
</summary>
|
||||
<short>
|
||||
path
|
||||
</short>
|
||||
<returns>path</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetMessageCount">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.RemoveXmppConnection(System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.AddXmppConnection(System.String,System.Byte)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetState(System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.SendState(System.Byte)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.SendMessage(System.String,System.String,System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetAllStates">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetRecentMessages(System.String,System.Int32)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.Ping(System.Byte)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.RegisterMobileAppInstall(ASC.Core.Common.Notify.Push.MobileAppType)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetBackupSchedule">
|
||||
<summary>
|
||||
Returns the backup schedule of the current portal
|
||||
</summary>
|
||||
<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)">
|
||||
<summary>
|
||||
Create the backup schedule of the current portal
|
||||
</summary>
|
||||
<param name="storageType">Storage type</param>
|
||||
<param name="storageParams">Storage parameters</param>
|
||||
<param name="backupsStored">Max of the backup's stored copies</param>
|
||||
<param name="cronParams">Cron parameters</param>
|
||||
<param name="backupMail">Include mail in the backup</param>
|
||||
<category>Backup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.DeleteBackupSchedule">
|
||||
<summary>
|
||||
Delete the backup schedule of the current portal
|
||||
</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)">
|
||||
<summary>
|
||||
Start a backup of the current portal
|
||||
</summary>
|
||||
<param name="storageType">Storage Type</param>
|
||||
<param name="storageParams">Storage Params</param>
|
||||
<param name="backupMail">Include mail in the backup</param>
|
||||
<category>Backup</category>
|
||||
<returns>Backup Progress</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetBackupProgress">
|
||||
<summary>
|
||||
Returns the progress of the started backup
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<returns>Backup Progress</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetBackupHistory">
|
||||
<summary>
|
||||
Returns the backup history of the started backup
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<returns>Backup History</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.DeleteBackup(System.Guid)">
|
||||
<summary>
|
||||
Delete the backup with the specified id
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.DeleteBackupHistory">
|
||||
<summary>
|
||||
Delete all backups of the current portal
|
||||
</summary>
|
||||
<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)">
|
||||
<summary>
|
||||
Start a data restore of the current portal
|
||||
</summary>
|
||||
<param name="backupId">Backup Id</param>
|
||||
<param name="storageType">Storage Type</param>
|
||||
<param name="storageParams">Storage Params</param>
|
||||
<param name="notify">Notify about backup to users</param>
|
||||
<category>Backup</category>
|
||||
<returns>Restore Progress</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetRestoreProgress">
|
||||
<summary>
|
||||
Returns the progress of the started restore
|
||||
</summary>
|
||||
<category>Backup</category>
|
||||
<returns>Restore Progress</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.UpdatePortalName(System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.SendCongratulations(System.Guid,System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.RemoveCommentComplete(System.String,System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.CancelCommentComplete(System.String,System.String,System.Boolean)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.EditCommentComplete(System.String,System.String,System.String,System.Boolean)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.GetBarPromotions(System.String,System.String)">
|
||||
<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)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.MarkBarTip(System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Portal.PortalApi.DeleteBarTips">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="P:ASC.Api.Portal.PortalApi.Name">
|
||||
<summary>
|
||||
Api name entry
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Portal.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Portal.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Projects.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Projects.dll
Normal file
Binary file not shown.
1736
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Projects.xml
Normal file
1736
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Projects.xml
Normal file
File diff suppressed because it is too large
Load Diff
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Settings.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Settings.dll
Normal file
Binary file not shown.
332
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Settings.xml
Normal file
332
helpcenter.r7-office.ru/Web/Bin/ASC.Api.Settings.xml
Normal file
@ -0,0 +1,332 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Api.Settings</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:ASC.Api.Settings.SettingsApi">
|
||||
<summary>
|
||||
Portal settings
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetSsoSettingsV2">
|
||||
<summary>
|
||||
Returns current portal SSO settings
|
||||
</summary>
|
||||
<short>
|
||||
Get SSO settings
|
||||
</short>
|
||||
<returns>SsoSettingsV2 object</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetDefaultSsoSettingsV2">
|
||||
<summary>
|
||||
Returns default portal SSO settings
|
||||
</summary>
|
||||
<short>
|
||||
Get default SSO settings
|
||||
</short>
|
||||
<returns>SsoSettingsV2 object</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetSsoSettingsV2Constants">
|
||||
<summary>
|
||||
Returns SSO settings constants
|
||||
</summary>
|
||||
<short>
|
||||
Get SSO settings constants
|
||||
</short>
|
||||
<returns>object</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveSsoSettingsV2(System.String)">
|
||||
<summary>
|
||||
Save SSO settings for current portal
|
||||
</summary>
|
||||
<short>
|
||||
Save SSO settings
|
||||
</short>
|
||||
<param name="serializeSettings">serialized SsoSettingsV2 object</param>
|
||||
<returns>SsoSettingsV2 object</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.ResetSsoSettingsV2">
|
||||
<summary>
|
||||
Reset SSO settings for current portal
|
||||
</summary>
|
||||
<short>
|
||||
Reset SSO settings
|
||||
</short>
|
||||
<returns>SsoSettingsV2 object</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetLdapSettings">
|
||||
<summary>
|
||||
Returns current portal LDAP settings
|
||||
</summary>
|
||||
<short>
|
||||
Get LDAP settings
|
||||
</short>
|
||||
<returns>LDAPSupportSettings object</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SyncLdap">
|
||||
<summary>
|
||||
Start sync users and groups process by LDAP
|
||||
</summary>
|
||||
<short>
|
||||
Sync LDAP
|
||||
</short>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TestLdapSync">
|
||||
<summary>
|
||||
Starts the process of collecting preliminary changes on the portal according to the selected LDAP settings
|
||||
</summary>
|
||||
<short>
|
||||
Sync LDAP
|
||||
</short>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveLdapSettings(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Save LDAP settings and start import/sync users and groups process by LDAP
|
||||
</summary>
|
||||
<short>
|
||||
Save LDAP settings
|
||||
</short>
|
||||
<param name="settings">LDAPSupportSettings serialized string</param>
|
||||
<param name="acceptCertificate">Flag permits errors of checking certificates</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TestLdapSave(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Starts the process of collecting preliminary changes on the portal according to the LDAP settings
|
||||
</summary>
|
||||
<short>
|
||||
Save LDAP settings
|
||||
</short>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetLdapOperationStatus">
|
||||
<summary>
|
||||
Returns LDAP sync process status
|
||||
</summary>
|
||||
<short>
|
||||
Get LDAP sync process status
|
||||
</short>
|
||||
<returns>LDAPSupportSettingsResult object</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetDefaultLdapSettings">
|
||||
<summary>
|
||||
Returns LDAP default settings
|
||||
</summary>
|
||||
<short>
|
||||
Get LDAP default settings
|
||||
</short>
|
||||
<returns>LDAPSupportSettings object</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetSettings">
|
||||
<summary>
|
||||
Returns the list of all available portal settings with the current values for each one
|
||||
</summary>
|
||||
<short>
|
||||
Portal settings
|
||||
</short>
|
||||
<returns>Settings</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetQuotaUsed">
|
||||
<summary>
|
||||
Returns space usage quota for portal with the space usage of each module
|
||||
</summary>
|
||||
<short>
|
||||
Space usage
|
||||
</short>
|
||||
<returns>Space usage and limits for upload</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.RecalculateQuota">
|
||||
<summary>
|
||||
Start Recalculate Quota Task
|
||||
</summary>
|
||||
<short>
|
||||
Recalculate Quota
|
||||
</short>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.CheckRecalculateQuota">
|
||||
<summary>
|
||||
Check Recalculate Quota Task
|
||||
</summary>
|
||||
<short>
|
||||
Check Recalculate Quota Task
|
||||
</short>
|
||||
<returns>Check Recalculate Quota Task Status</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetBuildVersions">
|
||||
<summary>
|
||||
Get build version
|
||||
</summary>
|
||||
<visible>false</visible>
|
||||
<returns>Current onlyoffice, editor, mailserver versions</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetVersions">
|
||||
<summary>
|
||||
Get list of availibe portal versions including current version
|
||||
</summary>
|
||||
<short>
|
||||
Portal versions
|
||||
</short>
|
||||
<visible>false</visible>
|
||||
<returns>List of availibe portal versions including current version</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SetVersion(System.Int32)">
|
||||
<summary>
|
||||
Set current portal version to the one with the ID specified in the request
|
||||
</summary>
|
||||
<short>
|
||||
Change portal version
|
||||
</short>
|
||||
<param name="versionId">Version ID</param>
|
||||
<visible>false</visible>
|
||||
<returns>List of availibe portal versions including current version</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetWebItemSecurityInfo(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Returns security settings about product, module or addons
|
||||
</summary>
|
||||
<short>
|
||||
Get security settings
|
||||
</short>
|
||||
<param name="ids">Module ID list</param>
|
||||
<returns></returns>
|
||||
</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
|
||||
</summary>
|
||||
<short>
|
||||
Set security settings
|
||||
</short>
|
||||
<param name="id">Module ID</param>
|
||||
<param name="enabled">Enabled</param>
|
||||
<param name="subjects">User (Group) ID list</param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SetAccessToWebItems(System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String,System.Boolean}})">
|
||||
<summary>
|
||||
Set access to products, modules or addons
|
||||
</summary>
|
||||
<short>
|
||||
Set access
|
||||
</short>
|
||||
<param name="items"></param>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetLogo">
|
||||
<summary>
|
||||
Get portal logo image URL
|
||||
</summary>
|
||||
<short>
|
||||
Portal logo
|
||||
</short>
|
||||
<returns>Portal logo image URL</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveWhiteLabelSettings(System.String,System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Int32,System.String}})">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveWhiteLabelSettingsFromFiles(System.Collections.Generic.IEnumerable{System.Web.HttpPostedFileBase})">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetWhiteLabelSizes">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetWhiteLabelLogos(System.Boolean)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetWhiteLabelLogoText">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.RestoreWhiteLabelOptions">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetIpRestrictions">
|
||||
<summary>
|
||||
Get portal ip restrictions
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveIpRestrictions(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
save new portal ip restrictions
|
||||
</summary>
|
||||
<param name="ips">ip restrictions</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.UpdateIpRestrictionsSettings(System.Boolean)">
|
||||
<summary>
|
||||
update ip restrictions settings
|
||||
</summary>
|
||||
<param name="enable">enable ip restrictions settings</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.UpdateTipsSettings(System.Boolean)">
|
||||
<summary>
|
||||
update tips settings
|
||||
</summary>
|
||||
<param name="show">show tips for user</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.CompleteWizard">
|
||||
<summary>
|
||||
Complete Wizard
|
||||
</summary>
|
||||
<returns>WizardSettings</returns>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SmsSettings(System.Boolean)">
|
||||
<summary>
|
||||
Update two-factor authentication settings
|
||||
</summary>
|
||||
<param name="enable">Enable two-factor authentication</param>
|
||||
<returns>Setting value</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.CloseWelcomePopup">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveColorTheme(System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.TimaAndLanguage(System.String,System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.SaveDefaultPageSettings(System.String)">
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.RefreshLicense">
|
||||
<summary>
|
||||
Refresh license
|
||||
</summary>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetCustomNavigationItems">
|
||||
<summary>
|
||||
Get Custom Navigation Items
|
||||
</summary>
|
||||
<returns>CustomNavigationItem List</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetCustomNavigationItemSample">
|
||||
<summary>
|
||||
Get Custom Navigation Items Sample
|
||||
</summary>
|
||||
<returns>CustomNavigationItem Sample</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.GetCustomNavigationItem(System.Guid)">
|
||||
<summary>
|
||||
Get Custom Navigation Item by Id
|
||||
</summary>
|
||||
<param name="id">Item id</param>
|
||||
<returns>CustomNavigationItem</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.CreateCustomNavigationItem(ASC.Web.Studio.Core.CustomNavigationItem)">
|
||||
<summary>
|
||||
Add Custom Navigation Item
|
||||
</summary>
|
||||
<param name="item">Item</param>
|
||||
<returns>CustomNavigationItem</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Api.Settings.SettingsApi.DeleteCustomNavigationItem(System.Guid)">
|
||||
<summary>
|
||||
Delete Custom Navigation Item by Id
|
||||
</summary>
|
||||
<param name="id">Item id</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Api.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Common.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Common.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Core.Common.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Core.Common.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Data.Reassigns.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Data.Reassigns.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.IPSecurity.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.IPSecurity.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Mail.Aggregator.Common.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Mail.Aggregator.Common.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Mail.Aggregator.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Mail.Aggregator.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.SingleSignOn.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.SingleSignOn.dll
Normal file
Binary file not shown.
101
helpcenter.r7-office.ru/Web/Bin/ASC.Specific.XML
Normal file
101
helpcenter.r7-office.ru/Web/Bin/ASC.Specific.XML
Normal file
@ -0,0 +1,101 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>ASC.Specific</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint">
|
||||
<summary>
|
||||
Authorization for api
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.AuthenticateMe(System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Gets authentication token for use in api authorization
|
||||
</summary>
|
||||
<short>
|
||||
Get token
|
||||
</short>
|
||||
<param name="userName">user name or email</param>
|
||||
<param name="password">password</param>
|
||||
<param name="provider">social media provider type</param>
|
||||
<param name="accessToken">provider token</param>
|
||||
<returns>tokent to use in 'Authorization' header when calling API methods</returns>
|
||||
<exception cref="T:System.Security.Authentication.AuthenticationException">Thrown when not authenticated</exception>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.SaveMobilePhone(System.String,System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Set mobile phone for user
|
||||
</summary>
|
||||
<param name="userName">user name or email</param>
|
||||
<param name="password">password</param>
|
||||
<param name="provider">social media provider type</param>
|
||||
<param name="accessToken">provider token</param>
|
||||
<param name="mobilePhone">new mobile phone</param>
|
||||
<returns>mobile phone</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.SendSmsCode(System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Send sms code again
|
||||
</summary>
|
||||
<param name="userName">user name or email</param>
|
||||
<param name="password">password</param>
|
||||
<param name="provider">social media provider type</param>
|
||||
<param name="accessToken">provider token</param>
|
||||
<returns>mobile phone</returns>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.AuthenticateMe(System.String,System.String,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Gets two-factor authentication token for use in api authorization
|
||||
</summary>
|
||||
<short>
|
||||
Get token
|
||||
</short>
|
||||
<param name="userName">user name or email</param>
|
||||
<param name="password">password</param>
|
||||
<param name="provider">social media provider type</param>
|
||||
<param name="accessToken">provider token</param>
|
||||
<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)">
|
||||
<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>
|
||||
<visible>false</visible>
|
||||
</member>
|
||||
<member name="P:ASC.Specific.AuthorizationApi.AuthenticationEntryPoint.Name">
|
||||
<summary>
|
||||
Entry point name
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint">
|
||||
<summary>
|
||||
Capabilities for api
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint.#ctor(ASC.Api.Impl.ApiContext)">
|
||||
<summary>
|
||||
Constructor
|
||||
</summary>
|
||||
<param name="context"></param>
|
||||
</member>
|
||||
<member name="M:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint.GetPortalCapabilities">
|
||||
<summary>
|
||||
Returns the information about portal capabilities
|
||||
</summary>
|
||||
<short>
|
||||
Get portal capabilities
|
||||
</short>
|
||||
<returns>CapabilitiesData</returns>
|
||||
</member>
|
||||
<member name="P:ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint.Name">
|
||||
<summary>
|
||||
Entry point name
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Specific.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Specific.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Thrdparty.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Thrdparty.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.VoipService.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.VoipService.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.CRM.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.CRM.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Community.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Community.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Core.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Core.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Files.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Files.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Projects.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Projects.dll
Normal file
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Studio.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/ASC.Web.Studio.dll
Normal file
Binary file not shown.
Binary file not shown.
BIN
helpcenter.r7-office.ru/Web/Bin/Autofac.dll
Normal file
BIN
helpcenter.r7-office.ru/Web/Bin/Autofac.dll
Normal file
Binary file not shown.
205
helpcenter.r7-office.ru/Web/web.autofac.config
Normal file
205
helpcenter.r7-office.ru/Web/web.autofac.config
Normal file
@ -0,0 +1,205 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<autofac>
|
||||
<components>
|
||||
<container name ="api">
|
||||
<component
|
||||
type="ASC.Specific.AscApiConfiguration, ASC.Specific"
|
||||
service="ASC.Api.Interfaces.IApiConfiguration, ASC.Api"
|
||||
instance-scope="single-instance">
|
||||
<parameters>
|
||||
<parameter name="prefix" value="api" />
|
||||
<parameter name="version" value="2.0" />
|
||||
<parameter name="maxPage" value="1000" />
|
||||
</parameters>
|
||||
</component>
|
||||
<component
|
||||
type="ASC.Specific.AscCookieAuthorization, ASC.Specific"
|
||||
service="ASC.Api.Interfaces.IApiAuthorization, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
name="asc_cookie" />
|
||||
<component
|
||||
type="ASC.Specific.AscBasicAuthorization, ASC.Specific"
|
||||
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"
|
||||
instance-scope="single-instance"
|
||||
name="ProductSecurityFilter"/>
|
||||
<component
|
||||
type="ASC.Api.Employee.EmployeeApi, ASC.Api.Employee"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="people"/>
|
||||
<component
|
||||
type="ASC.Api.Employee.GroupsApi, ASC.Api.Employee"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="group"/>
|
||||
<component
|
||||
type="ASC.Api.Community.CommunityApi, ASC.Api.Community"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="community"/>
|
||||
<component
|
||||
type="ASC.Api.Projects.ProjectApi, ASC.Api.Projects"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="project"/>
|
||||
<component
|
||||
type="ASC.Api.Projects.ProjectBootstrap, ASC.Api.Projects"
|
||||
service="ASC.Api.Interfaces.IApiBootstrapper, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
name="projectRegistration"/>
|
||||
<component
|
||||
type="ASC.Api.CRM.CRMApi, ASC.Api.CRM"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="crm"/>
|
||||
<component
|
||||
type="ASC.Api.CRM.CRMBootstrap, ASC.Api.CRM"
|
||||
service="ASC.Api.Interfaces.IApiBootstrapper, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
name="crm"/>
|
||||
<component
|
||||
type="ASC.Api.Settings.SettingsApi, ASC.Api.Settings"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="settings"/>
|
||||
<component
|
||||
type="ASC.Api.Documents.DocumentsApi, ASC.Api.Documents"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="files"/>
|
||||
<component
|
||||
type="ASC.Api.Calendar.CalendarApi, ASC.Api.Calendar"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="calendar"/>
|
||||
<component
|
||||
type="ASC.Specific.AuthorizationApi.AuthenticationEntryPoint, ASC.Specific"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="authentication"/>
|
||||
<component
|
||||
type="ASC.Specific.CapabilitiesApi.CapabilitiesEntryPoint, ASC.Specific"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="capabilities"/>
|
||||
<component
|
||||
type="ASC.Api.Feed.FeedApi, ASC.Api.Feed"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="feed"/>
|
||||
<component
|
||||
type="ASC.Api.MailServer.MailServerApi, ASC.Api.MailServer"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="mailserver"/>
|
||||
<component
|
||||
type="ASC.Api.Mail.MailApi, ASC.Api.Mail"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="mail"/>
|
||||
<component
|
||||
type="ASC.Api.Portal.PortalApi, ASC.Api.Portal"
|
||||
service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
|
||||
name="portal"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiManager, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiManager, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiSmartListResponceFilter, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiResponceFilter, ASC.Api"
|
||||
inject-properties="yes"
|
||||
name="smartfilter">
|
||||
</component>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiMethodCall, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiMethodCall, ASC.Api"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiArgumentBuilder, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiArgumentBuilder, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.Serializers.JsonNetSerializer, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiSerializer, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"
|
||||
name="json.net.serializer"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.Responders.ContentResponder, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiResponder, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"
|
||||
name="content_responder"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.Responders.DirectResponder, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiResponder, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"
|
||||
name="direct_responder"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.Serializers.SerializerResponder, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiResponder, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"
|
||||
name="serialzer"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.Invokers.ApiSimpleMethodInvoker, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiMethodInvoker, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiStoragePath, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiStoragePath, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiKeyValueInMemoryStorage, ASC.Api"
|
||||
service="ASC.Api.Interfaces.Storage.IApiKeyValueStorage, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiRouteConfigurator, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiRouteConfigurator, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.Routing.ApiRouteRegistrator, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiRouteRegistrator, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"
|
||||
name="rest"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.Routing.ApiBatchRouteRegitrator, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiRouteRegistrator, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"
|
||||
name="batch"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.Routing.ApiAccessControlRouteRegistrator, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiRouteRegistrator, ASC.Api"
|
||||
instance-scope="single-instance"
|
||||
inject-properties="yes"
|
||||
name="access"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiHttpHandler, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiHttpHandler, ASC.Api"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiRouteHandler, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiRouteHandler, ASC.Api"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Batch.ApiBatchHttpHandler, ASC.Api"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Batch.ApiBatchRouteHandler, ASC.Api"
|
||||
inject-properties="yes"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiContext, ASC.Api"
|
||||
instance-scope="per-lifetime-scope"/>
|
||||
<component
|
||||
type="ASC.Api.Impl.ApiStandartResponce, ASC.Api"
|
||||
service="ASC.Api.Interfaces.IApiStandartResponce, ASC.Api"
|
||||
inject-properties="yes"/>
|
||||
</container>
|
||||
</components>
|
||||
</autofac>
|
||||
@ -1,6 +1,7 @@
|
||||
<?xml version="1.0"?>
|
||||
<configuration>
|
||||
<configSections>
|
||||
<section name="autofac" type="ASC.Common.DependencyInjection.AutofacConfigurationSection, ASC.Common"/>
|
||||
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
|
||||
<section name="storage" type="ASC.Data.Storage.Configuration.StorageConfigurationSection, ASC.Data.Storage"/>
|
||||
<section name="dotless" type="dotless.Core.configuration.DotlessConfigurationSectionHandler, dotless.Core" />
|
||||
@ -33,6 +34,7 @@
|
||||
<add key="google.search.cx" value="008948232141094346324:glg8zifznm8"/>
|
||||
<add key="google.search.key" value="AIzaSyCdJDyP6pf-C98Rr2aSzZW1GJbHd6iD7QY"/>
|
||||
</appSettings>
|
||||
<autofac configSource="web.autofac.config"/>
|
||||
<system.web>
|
||||
<customErrors mode="Off"/>
|
||||
<compilation debug="true" targetFramework="4.0">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user