No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 0a4f26d Dec 27, 2017
Permalink
Failed to load latest commit information.
ASC.Api.Sample Sample api project Dec 1, 2017
EmptySample Empty sample project Dec 1, 2017
Sample style fix Dec 20, 2017
LICENSE Create LICENSE Dec 27, 2017
README.md Update README.md Dec 27, 2017

README.md

License

CommunityServer-CustomModules

ONLYOFFICE Community Server allows to add custom links to the portal navigation. Links to your own webpages, third-party websites, etc. can be added using the portal Settings. More information about this here.

If you plan to write your own module and integrate it with the portal, use this repository and follow the steps below.

How it works

  1. Get ONLYOFFICE Community Server from https://github.com/ONLYOFFICE/CommunityServer

  2. Copy EmptySample and Sample to the Products folder here:

https://github.com/ONLYOFFICE/CommunityServer/tree/master/web/studio/ASC.Web.Studio/Products

  1. Copy ASC.Api.Sample to the ASC.Api folder here:

https://github.com/ONLYOFFICE/CommunityServer/tree/master/module/ASC.Api

  1. Add the following code lines to the https://github.com/ONLYOFFICE/CommunityServer/blob/master/build/msbuild/build.proj file:
<!-- Samples -->
<ProjectToBuild Include="$(ASCDir)web\studio\ASC.Web.Studio\Products\EmptySample\ASC.Web.EmptySample.csproj"/>
<ProjectToBuild Include="$(ASCDir)web\studio\ASC.Web.Studio\Products\Sample\ASC.Web.Sample.csproj"/>

and

<ProjectToBuild Include="$(ASCDir)module\ASC.Api\ASC.Api.Sample\ASC.Api.Sample.csproj"/>

See the already existing projects to find out where these lines should be added.

Please note! The order you type in the lines is very important.

  1. Add ASC.Api.Sample.SampleApi to the web\studio\ASC.Web.Studio\web.autofac.config file like this:
<component
          type="ASC.Api.Sample.SampleApi, ASC.Api.Sample"
          service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
          name="sample"/>
  1. Run the Build.bat file here:

https://github.com/ONLYOFFICE/CommunityServer/blob/master/build/Build.bat

How to create your own module for ONLYOFFICE

  1. Create an ASP.NET Web Application (ASC.Web.Sample) project and put it to the ...web\studio\ASC.Web.Studio\Products\Sample folder IMPORTANT!!! The output dll file name must be "ASC.Web.*.dll".

  2. Connect the required references from ...\web\studio\ASC.Web.Studio\bin\:

ASC.Common.dll
ASC.Core.Common.dll
ASC.Data.Storage.dll
ASC.Web.Core.dll
ASC.Web.Studio.dll
  1. Implement the IProduct interface in the ProductEntryPoint.cs file.

IMPORTANT!!! The ProductID must be unique Guid (in VS2012 it is generated as TOOLS -> GUID -> New GUID)

  1. Note: add the following lines to the AssemblyInfo.cs file:
[assembly: Product(typeof(ASC.Web.Sample.Configuration.ProductEntryPoint))]
  1. Inherit the Master from web\studio\ASC.Web.Studio\Masters\BaseTemplate.master

  2. Set the output path in the project properties like this:

<OutputPath>..\..\bin\</OutputPath>

so that the builds were created at the web\studio\ASC.Web.Studio\bin folder.

  1. The project can be built manually or using the builder. For the latter add the following lines to the build\msbuild\build.proj file:
<ProjectToBuild Include="$(ASCDir)web\studio\ASC.Web.Studio\Products\Sample\ASC.Web.Sample.csproj"/>

and run the build\Build.bat file.

  1. After the build, run the website at the localhost:port address, go to the "Modules & Tools" Settings page (http://localhost:port/management.aspx?type=2) and enable the new Sample module. It will be available in the portal header drop-down menu afterwards or using the direct link: http://localhost:port/products/sample/default.aspx

How to create API for your own module

  1. Create a Class Library (ASC.Api.Sample) project and put it to the ...module\ASC.Api\ASC.Api.Sample folder.

IMPORTANT!!! The output dll file name must be "ASC.Api.*.dll";

  1. Connect the required references from ...\web\studio\ASC.Web.Studio\bin\:
ASC.Api.dll
ASC.Web.Sample.dll
  1. Create the SampleApi class and implement the IApiEntryPoint interface:
public class SampleApi : IApiEntryPoint
{
    public string Name
    {
        get { return "sample"; }
    }
}
  1. Create public methods with the specific attributes:
[Attributes.Create("create", false)]
public SampleClass Create(string value)
{
    return SampleDao.Create(value);
}

The attribute specifies the type of method, the path by which this method will be called, the authorization and verification of the tariff plan in it. The possible options are shown below:

CreateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponds to the "POST" request
UpdateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponds to the "PUT" request
DeleteAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponds to the "DELETE" request
ReadAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponds to the "GET" request

the requiresAuthorization, checkPayment parameters are optional and have a value of true by default.

  1. Set the output path in the project properties as:
<OutputPath>..\..\..\web\studio\ASC.Web.Studio\bin\</OutputPath>
<DocumentationFile>..\..\..\web\studio\ASC.Web.Studio\bin\ASC.Api.Sample.XML</DocumentationFile>

so that the builds were created at the web\studio\ASC.Web.Studio\bin folder.

  1. The project can be built manually or using the builder. For the latter add the following lines to the build\msbuild\build.proj file:
<ProjectToBuild Include="$(ASCDir)module\ASC.Api\ASC.Api.Sample\ASC.Api.Sample.csproj"/>

and run the build\Build.bat file.

  1. IMPORTANT!!! Add ASC.Api.Sample.SampleApi to the web\studio\ASC.Web.Studio\web.autofac.config file:
<component
          type="ASC.Api.Sample.SampleApi, ASC.Api.Sample"
          service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
          name="sample"/>
  1. Build the project, run the website and test the method by making a query with jQuery:
$.ajax({
    type: "POST",
    url: "http://localhost:port/api/2.0/sample/create.json",
    data: {value: "create"}
});