C# Class IO.Swagger.Api.ProjectApi

Represents a collection of functions to interact with the API endpoints

Inheritance: IProjectApi

Afficher le fichier Open project: TNOCS/csTouch

Méthodes publiques

Méthode	Description
AddGroupToProject ( string projectId, Group body ) : ApiResponse	Create a group in a project Create a group in a project
AddGroupToProjectAsync ( string projectId, Group body ) : System.Threading.Tasks.Task	Create a group in a project Create a group in a project
AddLayerToProject ( string projectId, string groupId, string layerId ) : ApiResponse	Adds a layer to a project Adds a layer to a project
AddLayerToProjectAsync ( string projectId, string groupId, string layerId ) : System.Threading.Tasks.Task	Adds a layer to a project Adds a layer to a project
AddProject ( Project body ) : void	Add a new project to the system Adds a new project
AddProjectAsync ( Project body ) : System.Threading.Tasks.Task	Add a new project to the system Adds a new project
AllGroups ( string projectId ) : List	Returns all groups in a project Returns a list of groupIds in a project
AllGroupsAsync ( string projectId ) : System.Threading.Tasks.Task>	Returns all groups in a project Returns a list of groupIds in a project
AllProjects ( ) : Project>.Dictionary	Returns all projects Returns a list of projects
AllProjectsAsync ( ) : Project>>.System.Threading.Tasks.Task	Returns all projects Returns a list of projects
DeleteProject ( string projectId ) : void	Delete a project by ID Deletes an entire project
DeleteProjectAsync ( string projectId ) : System.Threading.Tasks.Task	Delete a project by ID Deletes an entire project
GetBasePath ( ) : String	Gets the base path of the API client.
GetProject ( string projectId ) : Project	Find project by ID Returns a single project
GetProjectAsync ( string projectId ) : System.Threading.Tasks.Task	Find project by ID Returns a single project
ProjectApi ( ApiClient apiClient = null ) : System	Initializes a new instance of the ProjectApi class.
ProjectApi ( String basePath ) : System	Initializes a new instance of the ProjectApi class.
RemoveGroup ( string projectId, string groupId ) : ApiResponse	Deletes a group from a project Deletes a group from a project
RemoveGroupAsync ( string projectId, string groupId ) : System.Threading.Tasks.Task	Deletes a group from a project Deletes a group from a project
RemoveLayerFromProject ( string projectId, string groupId, string layerId ) : ApiResponse	Deletes a layer from a project Deletes a layer from a project
RemoveLayerFromProjectAsync ( string projectId, string groupId, string layerId ) : System.Threading.Tasks.Task	Deletes a layer from a project Deletes a layer from a project
SetBasePath ( String basePath ) : void	Sets the base path of the API client.
UpdateProject ( Project body, string projectId ) : void	Update an existing project
UpdateProjectAsync ( Project body, string projectId ) : System.Threading.Tasks.Task	Update an existing project

Method Details

AddGroupToProject() public méthode

Create a group in a project Create a group in a project

public AddGroupToProject ( string projectId, Group body ) : ApiResponse
projectId	string	ID of the project to add the group to
body	IO.Swagger.Model.Group	JSON that will be used to create the group
Résultat	IO.Swagger.Model.ApiResponse

AddGroupToProjectAsync() public méthode

Create a group in a project Create a group in a project

public AddGroupToProjectAsync ( string projectId, Group body ) : System.Threading.Tasks.Task
projectId	string	ID of the project to add the group to
body	IO.Swagger.Model.Group	JSON that will be used to create the group
Résultat	System.Threading.Tasks.Task

AddLayerToProject() public méthode

Adds a layer to a project Adds a layer to a project

public AddLayerToProject ( string projectId, string groupId, string layerId ) : ApiResponse
projectId	string	ID of the project to add the layer to
groupId	string	id of the group to add the layer to
layerId	string	id of the layer that will be added
Résultat	IO.Swagger.Model.ApiResponse

AddLayerToProjectAsync() public méthode

Adds a layer to a project Adds a layer to a project

public AddLayerToProjectAsync ( string projectId, string groupId, string layerId ) : System.Threading.Tasks.Task
projectId	string	ID of the project to add the layer to
groupId	string	id of the group to add the layer to
layerId	string	id of the layer that will be added
Résultat	System.Threading.Tasks.Task

AddProject() public méthode

Add a new project to the system Adds a new project

public AddProject ( Project body ) : void
body	IO.Swagger.Model.Project	Project object that needs to be added to the datastorage
Résultat	void

AddProjectAsync() public méthode

Add a new project to the system Adds a new project

public AddProjectAsync ( Project body ) : System.Threading.Tasks.Task
body	IO.Swagger.Model.Project	Project object that needs to be added to the datastorage
Résultat	System.Threading.Tasks.Task

AllGroups() public méthode

Returns all groups in a project Returns a list of groupIds in a project

public AllGroups ( string projectId ) : List
projectId	string	ID of the project to get the groups from
Résultat	List

AllGroupsAsync() public méthode

Returns all groups in a project Returns a list of groupIds in a project

public AllGroupsAsync ( string projectId ) : System.Threading.Tasks.Task>
projectId	string	ID of the project to get the groups from
Résultat	System.Threading.Tasks.Task>

AllProjects() public méthode

Returns all projects Returns a list of projects

public AllProjects ( ) : Project>.Dictionary
Résultat	Project>.Dictionary

AllProjectsAsync() public méthode

Returns all projects Returns a list of projects

public AllProjectsAsync ( ) : Project>>.System.Threading.Tasks.Task
Résultat	Project>>.System.Threading.Tasks.Task

DeleteProject() public méthode

Delete a project by ID Deletes an entire project

public DeleteProject ( string projectId ) : void
projectId	string	ID of project to be deleted
Résultat	void

DeleteProjectAsync() public méthode

Delete a project by ID Deletes an entire project

public DeleteProjectAsync ( string projectId ) : System.Threading.Tasks.Task
projectId	string	ID of project to be deleted
Résultat	System.Threading.Tasks.Task

GetBasePath() public méthode

Gets the base path of the API client.

public GetBasePath ( ) : String
Résultat	String

GetProject() public méthode

Find project by ID Returns a single project

public GetProject ( string projectId ) : Project
projectId	string	ID of the project to be returned
Résultat	IO.Swagger.Model.Project

GetProjectAsync() public méthode

Find project by ID Returns a single project

public GetProjectAsync ( string projectId ) : System.Threading.Tasks.Task
projectId	string	ID of the project to be returned
Résultat	System.Threading.Tasks.Task

ProjectApi() public méthode

Initializes a new instance of the ProjectApi class.

public ProjectApi ( ApiClient apiClient = null ) : System
apiClient	IO.Swagger.Client.ApiClient	an instance of ApiClient (optional)
Résultat	System

ProjectApi() public méthode

Initializes a new instance of the ProjectApi class.

public ProjectApi ( String basePath ) : System
basePath	String
Résultat	System

RemoveGroup() public méthode

Deletes a group from a project Deletes a group from a project

public RemoveGroup ( string projectId, string groupId ) : ApiResponse
projectId	string	ID of the project to remove the layer from
groupId	string	id of the group that will be removed
Résultat	IO.Swagger.Model.ApiResponse

RemoveGroupAsync() public méthode

Deletes a group from a project Deletes a group from a project

public RemoveGroupAsync ( string projectId, string groupId ) : System.Threading.Tasks.Task
projectId	string	ID of the project to remove the layer from
groupId	string	id of the group that will be removed
Résultat	System.Threading.Tasks.Task

RemoveLayerFromProject() public méthode

Deletes a layer from a project Deletes a layer from a project

public RemoveLayerFromProject ( string projectId, string groupId, string layerId ) : ApiResponse
projectId	string	ID of the project to remove the layer from
groupId	string	id of the group to add the layer to
layerId	string	id of the layer that will be removed
Résultat	IO.Swagger.Model.ApiResponse

RemoveLayerFromProjectAsync() public méthode

Deletes a layer from a project Deletes a layer from a project

public RemoveLayerFromProjectAsync ( string projectId, string groupId, string layerId ) : System.Threading.Tasks.Task
projectId	string	ID of the project to remove the layer from
groupId	string	id of the group to add the layer to
layerId	string	id of the layer that will be removed
Résultat	System.Threading.Tasks.Task

SetBasePath() public méthode

Sets the base path of the API client.

public SetBasePath ( String basePath ) : void
basePath	String	The base path
Résultat	void

UpdateProject() public méthode

Update an existing project

public UpdateProject ( Project body, string projectId ) : void
body	IO.Swagger.Model.Project	JSON that will be used to update the project
projectId	string	ID or Name of the project to update
Résultat	void

UpdateProjectAsync() public méthode

Update an existing project

public UpdateProjectAsync ( Project body, string projectId ) : System.Threading.Tasks.Task
body	IO.Swagger.Model.Project	JSON that will be used to update the project
projectId	string	ID or Name of the project to update
Résultat	System.Threading.Tasks.Task