C# Class Syncano.Net.Api.AdministratorSyncanoClient

Class with Administrator management api.

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

Méthodes publiques

Méthode	Description
AdministratorSyncanoClient ( ISyncanoClient syncanoClient ) : System	Creates AdministratorSyncanoClient object.
Delete ( string adminId = null, string adminEmail = null ) : Task	Deletes specified administrator from current instance. Only administrators whose role is defined as "Admin" or "Owner" can edit their instance's administrators. Admin_id/admin_email parameter means that one can use either one of them - admin_id or admin_email.
Get ( ) : Task>	Get the all administrators of the current instance.
GetOne ( string adminId = null, string adminEmail = null ) : Task	Gets admin info with specific id or email from the current instance. Admin_id/admin_email parameter means that one can use either one of them - admin_id or admin_email.
GetRoles ( ) : Task>	Lists all permission roles of current instance.
New ( string adminEmail, string roleId, string message ) : Task	Adds a new administrator to current instance (sends an invitation). Only Admin permission role can add new administrators.
Update ( string roleId, string adminId = null, string adminEmail = null ) : Task	Updates specified admin's permission role. Only administrators whose role is defined as "Admin" or "Owner" can edit their instance's administrators.

Method Details

AdministratorSyncanoClient() public méthode

Creates AdministratorSyncanoClient object.

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

Delete() public méthode

Deletes specified administrator from current instance. Only administrators whose role is defined as "Admin" or "Owner" can edit their instance's administrators. Admin_id/admin_email parameter means that one can use either one of them - admin_id or admin_email.

public Delete ( string adminId = null, string adminEmail = null ) : Task
adminId	string	Admin id defining admin to delete.
adminEmail	string	Admin email defining admin to delete.
Résultat	Task

Get() public méthode

Get the all administrators of the current instance.

public Get ( ) : Task>
Résultat	Task>

GetOne() public méthode

Gets admin info with specific id or email from the current instance. Admin_id/admin_email parameter means that one can use either one of them - admin_id or admin_email.

public GetOne ( string adminId = null, string adminEmail = null ) : Task
adminId	string	Admin id.
adminEmail	string	Admin email.
Résultat	Task

GetRoles() public méthode

Lists all permission roles of current instance.

public GetRoles ( ) : Task>
Résultat	Task>

New() public méthode

Adds a new administrator to current instance (sends an invitation). Only Admin permission role can add new administrators.

public New ( string adminEmail, string roleId, string message ) : Task
adminEmail	string	Email of administrator to add.
roleId	string	Initial role for current instance (see role.get()).
message	string	Message that will be sent along with invitation to instance.
Résultat	Task

Update() public méthode

Updates specified admin's permission role. Only administrators whose role is defined as "Admin" or "Owner" can edit their instance's administrators.

public Update ( string roleId, string adminId = null, string adminEmail = null ) : Task
roleId	string	New admin's instance role id to set (see role.get()).
adminId	string	The admin id to update.
adminEmail	string	The admin email to update.
Résultat	Task