Skip to content

SyncfusionExamples/sharepoint-aspcore-file-provider

BranchesTags

Repository files navigation

sharepoint-aspcore-file-provider

This repository contains the ASP.NET Core SharePoint file system providers for the Syncfusion File Manager component.

Key Features

The SharePoint file system provider offers file system support for the FileManager component with Microsoft SharePoint.

The following actions can be performed with the SharePoint file system provider:

Actions Description
Read Reads the files from the SharePoint document library.
Details Provides details about files Type, Size, Location and Modified date.
Download Downloads the selected file or folder from the SharePoint document library.
Upload Uploads files to the SharePoint document library. It accepts uploaded media with the following characteristics:
  • Maximum file size: 30MB
  • Accepted Media MIME types: /
Create Creates a new folder in the SharePoint document library.
Delete Removes a file or folder from the SharePoint document library.
Copy Copies the selected files to the target location within the SharePoint document library.
Move Moves the copied files to the desired location within the SharePoint document library.
Rename Renames a folder or file in the SharePoint document library.
Search Searches for a file or folder in the SharePoint document library.

Prerequisites

To set up the SharePoint service provider, follow these steps:

  1. Create an App Registration in Azure Active Directory (AAD):

    • Navigate to the Azure portal and create a new app registration under Azure Active Directory.
    • Note down the Tenant ID, Client ID, and Client Secret from the app registration.

  2. Use Microsoft Graph Instance:

    • With the obtained Tenant ID, Client ID, and Client Secret, you can create a Microsoft Graph instance.
    • This instance will be used to interact with the SharePoint document library.

  3. Use Details from appsettings.json:

    • The SharePointController is already configured to use the credentials provided in the appsettings.json file.
    • You only need to provide your Tenant ID, Client ID, Client Secret, User Site Name, and User Drive ID in the appsettings.json file, and the application will automatically initialize the SharePoint service.

    Example appsettings.json Configuration

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "SharePointSettings": {
    "TenantId": "<--Tenant Id-->",
    "ClientId": "<--Client Id-->",
    "ClientSecret": "<--Client Secret-->",
    "UserSiteName": "<--User Site Name-->",
    "UserDriveId": "<--User Drive ID-->"
  },
  "AllowedHosts": "*"
}

Replace "<--User Site Name-->", "<--User Drive ID-->", "tenantId", "clientId", and "clientSecret" with your actual values.

How to run this application?

  • Checkout this project to a location in your disk.
  • Open the solution file using Visual Studio 2022.
  • Restore the NuGet packages by rebuilding the solution.
  • Run the project.

Running application

Once cloned, open solution file in visual studio.Then build the project after restoring the nuget packages and run it.

File Manager AjaxSettings

To access the basic actions such as Read, Delete, Copy, Move, Rename, Search, and Get Details of File Manager using the SharePoint service, map the following code snippet in the AjaxSettings property of File Manager. Please refer to the platform-specific documentation for more details:

Here, the hostUrl will be your locally hosted port number.

  var hostUrl = http://localhost:62870/;
  ajaxSettings: {
        url: hostUrl + 'api/SharePointProvider/SharePointFileOperations'
  }

Refer to the below File Manager UG Documentation:

File download AjaxSettings

To perform download operation, initialize the downloadUrl property in ajaxSettings of the File Manager component.

  var hostUrl = http://localhost:62870/;
  ajaxSettings: {
    url: hostUrl + 'api/SharePointProvider/SharePointFileOperations',
    downloadUrl: hostUrl + 'api/SharePointProvider/SharePointDownload'
  }

File upload AjaxSettings

To perform upload operation, initialize the uploadUrl property in ajaxSettings of the File Manager component.

  var hostUrl = http://localhost:62870/;
  ajaxSettings: {
    url: hostUrl + 'api/SharePointProvider/SharePointFileOperations',
    uploadUrl: hostUrl + 'api/SharePointProvider/SharePointUpload'
  }

File image preview AjaxSettings

To perform image preview support in the File Manager component, initialize the getImageUrl property in ajaxSettings of the File Manager component.

  var hostUrl = http://localhost:62870/;
  ajaxSettings: {
    url: hostUrl + 'api/SharePointProvider/SharePointFileOperations',
    getImageUrl: hostUrl + 'api/SharePointProvider/SharePointGetImage'
  }

Support

Product support is available for through following mediums.

License

Check the license detail here.

About

sharepoint-aspcore-file-provider

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages