Methods
Last updated
Was this helpful?
Last updated
Was this helpful?
The main goal of this Web Service is to manipulate the Access Profiles set up. The following methods are available for that purpose. By combining these methods, you will be able to perform pretty much any task regarding the profiles set up.
Method name
Method description
Input params
Output params
Exceptions
GetAllProfiles
Retrieves all the existing profiles.
:
all existing profiles from Thinfinity® Remote Desktop Server
If there are no profiles yet, returns a WSProfileArray with length = 0.
GetProfileCount
Counts how many profiles exist.
integer:
profiles count
GetProfile
Returns a profile located on a determined index.
integer:
profile index
:
profile located on the informed index.
If there is no profile on the indicated index, returns null.
FindByID
Returns the profile that has the indicated ID.
string:
profile ID
:
profile that has the informed ID.
If there is no profile that has the indicated ID, returns null.
FindByComputer
Returns all profiles associated with a computer.
string:
computer IP
:
profiles associated with the informed computer.
If there are no profiles associated with the computer, returns a WSProfileArray with length = 0.
FindByUserName
Returns all profiles assigned to the user.
string:
username
:
user granted profiles.
If there is are no profiles associated with the user, returns a WSProfileArray with length = 0.
CreateProfile
Creates a new profile.
:
profile to be created
:
created profile carrying the new generated ID and public Key.
If the profile could not be created, returns null.
DeleteProfile
Deletes an existing profile.
string:
profile ID
boolean:
returns true if the deletion was successful and false if the application could not delete the profile.
If there is no profile with the indicated ID, returns false.
UpdateProfile
Updates an existing profile.
:
profile to be updated with the new data already loaded in its structure.
int:
returns 0 if the profile was updated successfully. Any value different from 0 means the update could not be performed.
If there is no profile matching the WSProfile ID, returns a value <> 0.
NewPublicKey
Generates a new public key for an existing profile.
string:
profile ID
:
profile carrying the new Public Key.
If there is no profile matching the WSProfile ID, returns null.
Commit
Commits all the performed methods since the last commit or rollback.
Rollback
Rollbacks all the performed methods since the last commit or rollback.