Getting Started With Vizit APIs

Most of Vizit's custom APIs follow the same procedure for creating and implementing. This article provides the basic instructions for working with custom code for Vizit, and contains links to particular instructions for each type of API.

 

Download the Examples

Download this file and extract it to find sample files for our custom APIs: http://files.vizit.com/public/CodeSamples/PluginExamples.zip

These will provide a good example or starting point for your own custom code.

Obtaining and Referencing Vizit.API and Vizit.API.Interfaces

Almost all of the APIs require that you extract and reference the Vizit.API and Vizit.API.Interfaces DLLs from the Vizit project. Please take a look at this page for instructions: http://support.vizit.com/entries/52832175-Obtaining-and-Referencing-Vizit-API-and-Vizit-API-Interfaces

Registering/Unregistering the Custom Code

If you need more in-depth instructions on the operations in the following step, please reference this page: http://support.vizit.com/entries/33206589-Basic-NET-SharePoint-assembly-operations

After you have created the logic for your custom code, we can build and deploy it.

The assembly needs to be signed and placed into the Global Assembly Cache (see above link for help on this step).

Since Vizit Pro logic is run on the Web Front Ends, it would be a good idea to deploy the assembly as part of a SharePoint solution. An additional note about your custom assembly is that for SharePoint 2010, it must be built against .NET 3.5. 2013 assemblies should be built against .NET 4.

To register your assembly, the easiest approach would be to add a console project to your custom code solution. In the Main method of the Program, you must construct your custom annotation, and through a reference to the Vizit.API assembly, call the static Vizit.API.Plugins.Registrar.RegisterPlugin method. Here is an example using a custom annotation:

static void Main(string[] args)
{
var plugin = new CustomAnnotations.Logo();
Vizit.API.Plugins.Registrar.RegisterPlugin(plugin);
}

A reference file for this action can be found in the example plugins ZIP in \RegisterPlugins\Program.cs

Run this console program on your SharePoint environment and your plugin will be registered. It only needs to be run once. If your assembly version number or name changes, you will need to run this again. Keep in mind that the Id property should always return the same value.

If you would like to unregister a custom plugin, simply change your register code to unregister code (reference the file in the example ZIP in \RegisterPlugins\Program.cs) and run your console project again.

Specific Instructions for Different Types of APIs:

Custom Annotations: http://support.vizit.com/entries/30071676-Custom-Annotations-in-Vizit-Pro

Custom Watermarks: http://support.vizit.com/entries/31096416-Custom-Watermarking-in-Vizit-Essential-and-Instant-Previews

Custom DRM (Digital Rights Management) Rules: http://support.vizit.com/entries/48596923-Customize-Vizit-DRM-with-the-IFileDrmPlugin

Custom Configuration Profiles for Vizit Pro: http://support.vizit.com/entries/49243687-Easily-Deploy-Configuration-Profiles-for-Vizit-Pro-with-the-IProConfiguration-Plugin

Custom Access Rules for Vizit Pro and Essential for Specific Users: http://support.vizit.com/entries/49087965-Enabling-Disabling-Vizit-Pro-Essential-for-Certain-Users

Rendering Unsupported File Formats in Vizit: http://support.vizit.com/entries/30608048-Rendering-Unsupported-File-Formats-in-Vizit

Custom File Retriever: http://support.vizit.com/entries/30279806-Viewing-Files-Outside-of-SharePoint-with-IFileRetriever

Export to PDF With Pro Annotations: http://support.vizit.com/entries/22417977-Using-Vizit-API-to-Export-to-PDF-with-Pro-Annotations

License Vizit Programatically: http://support.vizit.com/entries/28061077-Using-Vizit-API-to-License-Vizit-Programmatically

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk