C# Class Syncano.Net.Api.FolderSyncanoClient

Class with Folder management api.

Afficher le fichier Open project: Syncano/syncano-dotnet Class Usage Examples

Méthodes publiques

Méthode	Description
Authorize ( string apiClientId, Permissions permission, string projectId, string folderName, string collectionId = null, string collectionKey = null ) : Task	Adds container-level permission to specified User API client. Requires Backend API key with Admin permission role. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.
Deauthorize ( string apiClientId, Permissions permission, string projectId, string folderName, string collectionId = null, string collectionKey = null ) : Task	Removes container-level permission from specified User API client. Requires Backend API key with Admin permission role. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.
Delete ( string projectId, string name, string collectionId = null, string collectionKey = null ) : Task	Permanently delete specified folder and all associated data. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.
FolderSyncanoClient ( ISyncanoClient syncanoClient ) : System	Creates FolderSyncanoClient object.
Get ( string projectId, string collectionId = null, string collectionKey = null ) : Task>	Get folders for a specified collection. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key. User API key usage permitted. Returns only collections that have``read_data`` permission added through folder.authorize(), collection.authorize() or project.authorize().
GetOne ( string projectId, string folderName, string collectionId = null, string collectionKey = null ) : Task	Get folder for a specified collection and folder name. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key. User API key usage permitted if read_data permission is added to specified folder through folder.authorize(), collection.authorize() or project.authorize().
New ( string projectId, string name, string collectionId = null, string collectionKey = null ) : Task	Create new folder within a specified collection. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.
Update ( string projectId, string name, string collectionId = null, string collectionKey = null, string newName = null, string sourceId = null ) : Task	Create existing folder. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.

Method Details

Authorize() public méthode

Adds container-level permission to specified User API client. Requires Backend API key with Admin permission role. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.

public Authorize ( string apiClientId, Permissions permission, string projectId, string folderName, string collectionId = null, string collectionKey = null ) : Task
apiClientId	string	User API client id.
permission	Permissions	User API client's permission to add.
projectId	string	Project containing specified container.
folderName	string	Folder name defining folder that permission will be added to.
collectionId	string	Collection containing specified container.
collectionKey	string	Collection containing specified container.
Résultat	Task

Deauthorize() public méthode

Removes container-level permission from specified User API client. Requires Backend API key with Admin permission role. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.

public Deauthorize ( string apiClientId, Permissions permission, string projectId, string folderName, string collectionId = null, string collectionKey = null ) : Task
apiClientId	string	User API client id.
permission	Permissions	User API client's permission to remove.
projectId	string	Project containing specified container.
folderName	string	Folder name defining folder that permission will be removed from.
collectionId	string	Collection containing specified container.
collectionKey	string	Collection containing specified container.
Résultat	Task

Delete() public méthode

Permanently delete specified folder and all associated data. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.

public Delete ( string projectId, string name, string collectionId = null, string collectionKey = null ) : Task
projectId	string	Project id.
name	string	Folder name to delete.
collectionId	string	Collection id defining collection where folder exists.
collectionKey	string	Collection key defining collection where folder exists.
Résultat	Task

FolderSyncanoClient() public méthode

Creates FolderSyncanoClient object.

public FolderSyncanoClient ( ISyncanoClient syncanoClient ) : System
syncanoClient	ISyncanoClient	Object implementing ISyncanoClient interface. Provides means for connecting to Syncano.
Résultat	System

Get() public méthode

Get folders for a specified collection. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key. User API key usage permitted. Returns only collections that have``read_data`` permission added through folder.authorize(), collection.authorize() or project.authorize().

public Get ( string projectId, string collectionId = null, string collectionKey = null ) : Task>
projectId	string	Project id.
collectionId	string	Collection id defining the collection for which folders will be returned.
collectionKey	string	Collection key defining the collection for which folders will be returned.
Résultat	Task>

GetOne() public méthode

Get folder for a specified collection and folder name. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key. User API key usage permitted if read_data permission is added to specified folder through folder.authorize(), collection.authorize() or project.authorize().

public GetOne ( string projectId, string folderName, string collectionId = null, string collectionKey = null ) : Task
projectId	string	Project id.
folderName	string	Folder name defining folder.
collectionId	string	Collection id defining a collection for which the folder will be returned.
collectionKey	string	Collection key defining a collection for which the folder will be returned.
Résultat	Task

New() public méthode

Create new folder within a specified collection.

The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.

public New ( string projectId, string name, string collectionId = null, string collectionKey = null ) : Task
projectId	string	Project id.
name	string	Folder name.
collectionId	string	Collection id defining collection where folder will be created.
collectionKey	string	Collection key defining collection where folder will be created.
Résultat	Task

Update() public méthode

Create existing folder. The collection_id/collection_key parameter means that one can use either one of them - collection_id or collection_key.

public Update ( string projectId, string name, string collectionId = null, string collectionKey = null, string newName = null, string sourceId = null ) : Task
projectId	string	Project id.
name	string	Current folder name.
collectionId	string	Collection id defining collection where folder exists.
collectionKey	string	Collection key defining collection where folder exists.
newName	string	New folder name.
sourceId	string	New source id, can be used for mapping folders to external source.
Résultat	Task