C# Class Syncano.Net.Api.ProjectSyncanoClient

Class with Project management api.
Exibir arquivo Open project: Syncano/syncano-dotnet Class Usage Examples

Public Methods

Method Description
Authorize ( string apiClientId, Permissions permission, string projectId ) : Task

Adds container-level permission to specified User API client. Requires Backend API key with Admin permission role.

Deauthorize ( string apiClientId, Permissions permission, string projectId ) : Task

Removes container-level permission from specified User API client. Requires Backend API key with Admin permission role.

Delete ( string projectId ) : Task

Delete (permanently) project with specified project_id.

Get ( ) : Task>

Get projects

User API key usage permitted. Returns only projects that have``read_data`` permission added through project.authorize().

GetOne ( string projectId ) : Task

Get one project.

User API key usage permitted if read_data permission is added to specified folder through project.authorize().

New ( string name, string description = null ) : Task

Create a new project.

ProjectSyncanoClient ( ISyncanoClient syncanoClient ) : System

Creates ProjectSyncanoClient object.

Update ( string projectId, string name = null, string description = null ) : Task

Update existing project.

Method Details

Authorize() public method

Adds container-level permission to specified User API client. Requires Backend API key with Admin permission role.
public Authorize ( string apiClientId, Permissions permission, string projectId ) : Task
apiClientId string User API client id.
permission Permissions User API client's permission to add.
projectId string Project id defining project that permission will be added to.
return Task

Deauthorize() public method

Removes container-level permission from specified User API client. Requires Backend API key with Admin permission role.
public Deauthorize ( string apiClientId, Permissions permission, string projectId ) : Task
apiClientId string User API client id.
permission Permissions User API client's permission to remove.
projectId string Project id defining project that permission will be removed from.
return Task

Delete() public method

Delete (permanently) project with specified project_id.
public Delete ( string projectId ) : Task
projectId string Project id defining project to be deleted.
return Task

Get() public method

Get projects
User API key usage permitted. Returns only projects that have``read_data`` permission added through project.authorize().
public Get ( ) : Task>
return Task>

GetOne() public method

Get one project.
User API key usage permitted if read_data permission is added to specified folder through project.authorize().
public GetOne ( string projectId ) : Task
projectId string Project id defining project.
return Task

New() public method

Create a new project.
public New ( string name, string description = null ) : Task
name string New project's name.
description string New project's description.
return Task

ProjectSyncanoClient() public method

Creates ProjectSyncanoClient object.
public ProjectSyncanoClient ( ISyncanoClient syncanoClient ) : System
syncanoClient ISyncanoClient Object implementing ISyncanoClient interface. Provides means for connecting to Syncano.
return System

Update() public method

Update existing project.
public Update ( string projectId, string name = null, string description = null ) : Task
projectId string Existing project's id.
name string New name of specified project.
description string New description of specified project.
return Task