Code Monkey home page Code Monkey logo

ftp-aspcore-file-provider's Introduction

FTP service for the file manager component

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

Key Features

A file system provider is an API for access to the hosted file system using File Transfer Protocol(FTP) in the FileManager control. It also provides the methods for performing various file actions like creating a new folder, renaming files and deleting files.

ASP.NET Core FTP file system provider serves the FTP file system for the file manager component.

The following actions can be performed with ASP.NET Core file system Provider.

Actions Description
Read Reads the files from the FTP file storage.
Details Gets a file's metadata which consists of Type, Size, Location and Modified date.
Download Downloads the selected file or folder.
Upload Upload's the file in hosted file system. It accepts uploaded media with the following characteristics:
  • Maximum file size: 30MB
  • Accepted Media MIME types: */*
Create Creates a new folder.
Delete Deletes a folder or file.
Copy Copies the contents of the file from the target location .
Move Paste the copied files to the desired location.
Rename Renames a folder or file.
Search Searches a file or folder.

Prerequisites

To run the service, open the FTPFileProvider and register the FTP details like hostName, userName, password details in the SetFTPConnection method to perform the file operations.

Provide the hostName parameter as like root path in the SetFTPConnection method.

   void SetFTPConnection(string hostName, string userName, string password);   

How to run this application?

To run this application, you need to first clone the ftp-aspcore-file-provider repository and then navigate to its appropriate path where it has been located in your system.

To do so, open the command prompt and run the below commands one after the other.

git clone https://github.com/SyncfusionExamples/ftp-aspcore-file-provider  ftp-aspcore-file-provider

cd ftp-aspcore-file-provider

Running application

Once cloned, open the 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 FTP service, just map the following code snippet in the AjaxSettings property of File Manager.

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

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

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/FTPProvider/FTPFileOperations',
        downloadUrl: hostUrl +'api/FTPProvider/FTPDownload'
  }

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/FTPProvider/FTPFileOperations',
        uploadUrl: hostUrl +'api/FTPProvider/FTPUpload'
  }

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/FTPProvider/FTPFileOperations',
         getImageUrl: hostUrl +'api/FTPProvider/FTPGetImage'
  }

The FileManager will be rendered as the following.

File Manager

Support

Product support is available for through following mediums.

License

Check the license detail here.

Changelog

Check the changelog here

© Copyright 2020 Syncfusion, Inc. All Rights Reserved. The Syncfusion Essential Studio license and copyright applies to this distribution.

ftp-aspcore-file-provider's People

Contributors

bhuvaneswarin avatar gsumankumar avatar keerthanarajendran avatar prasanthmadhaiyan avatar rajendranr-5483 avatar sarubala20 avatar sivakumars3442 avatar sowmiyapadmanaban avatar thirukumaran-murugan avatar vinothkumar-ganesan avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.