IZooClientUtilities

public interface IZooClientUtilities
Interface implemented in ZooClient and added to Rhino via dependency injection

Properties

LoggedInUserAvatar

#Since v6.0
Image LoggedInUserAvatar { get; }
Returns the logged in user's avatar picture. Returns a default avatar if the user does not have an avatar or if the avatar could not be fetched.

LoggedInUserName

#Since v6.0
string LoggedInUserName { get; }
Returns the name of the logged in user, or null if the user is not logged in.

UserIsLoggedIn

#Since v6.0
bool UserIsLoggedIn { get; }
Returns true if the user is logged in; else returns false. A logged in user does not guarantee that the auth tokens managed by the CloudZooManager instance are valid.

Methods

AskUserForLicense

#Since v6.0
bool AskUserForLicense(object verify, ZooClientParameters parameters)
Parameters:
verify (object)
parameters (ZooClientParameters)

CheckInLicense

#Since v6.0
bool CheckInLicense(object verify, Guid productId)
Checks in a checked out license to the owning Zoo.
Parameters:
verify (object)
productId (Guid)

CheckOutLicense

#Since v6.0
bool CheckOutLicense(object verify, Guid productId)
Checks out a loaned out license from the owning Zoo.
Parameters:
verify (object)
productId (Guid)

ConvertLicense

#Since v6.0
bool ConvertLicense(object verify, Guid productId)
Converts a standalone license to a network license.
Parameters:
verify (object)
productId (Guid)

DeleteLicense

#Since v6.0
bool DeleteLicense(object verify, Guid productId)
31-Mar-2015 Dale Fugier, http://mcneel.myjetbrains.com/youtrack/issue/MR-1725 Deletes a license along with its license file.
Parameters:
verify (object)
productId (Guid)

Echo

#Since v6.0
string Echo(object verify, string message)
Parameters:
verify (object)
message (string)

GetCurrentTime

#Since v6.0
DateTime GetCurrentTime()
Gets the current time, trying to access an NTP server before using local time.

GetLicense

#Since v6.0
bool GetLicense(object verify, ZooClientParameters parameters)
Parameters:
verify (object)
parameters (ZooClientParameters)

GetLicenseStatus

#Since v6.0
LicenseStatus[] GetLicenseStatus(object verify)
Returns the current status of every license for ui purposes
Parameters:
verify (object)

GetLicenseType

#Since v6.0
int GetLicenseType(object verify, Guid productId)
Returns the type of a specified product license
Parameters:
verify (object)
productId (Guid)

GetOneLicenseStatus

#Since v6.0
LicenseStatus GetOneLicenseStatus(object verify, Guid productId)
Returns the current status of a license for ui purposes
Parameters:
verify (object)
productId (Guid)

GetRegisteredOwnerInfo

#Since v6.0
bool GetRegisteredOwnerInfo(object verify, Guid productId, ref string registeredOwner, ref string registeredOrganization)
Returns the registered owner and organization of a license 4-Sept-2014 Dale Fugier, http://mcneel.myjetbrains.com/youtrack/issue/RH-28623
Parameters:
verify (object)
productId (Guid)
registeredOwner (ref string)
registeredOrganization (ref string)

Initialize

#Since v6.0
bool Initialize(object verify)
Parameters:
verify (object)

IsCheckOutEnabled

#Since v6.0
bool IsCheckOutEnabled(object verify)
Returns whether or not license checkout is enabled
Parameters:
verify (object)

LicenseOptionsHandler

#Since v6.0
bool LicenseOptionsHandler(object verify, ZooClientParameters parameters)
Parameters:
verify (object)
parameters (ZooClientParameters)

LoginToCloudZoo

#Since v6.0
bool LoginToCloudZoo()
Logs the user in to the cloud zoo. This logs out the current user and voids any existing leases.

LogoutOfCloudZoo

#Since v6.0
bool LogoutOfCloudZoo()
Logs the user out of the cloud zoo. This logs out the current user and voids any existing leases.

ReturnLicense

#Since v6.0
bool ReturnLicense(object verify, Guid productId)
Parameters:
verify (object)
productId (Guid)

ReturnLicense

#Since v6.0
bool ReturnLicense(object verify, string productPath, Guid productId)
Parameters:
verify (object)
productPath (string)
productId (Guid)

ShowBuyLicenseUi

#Since v6.0
void ShowBuyLicenseUi(object verify, Guid productId)
Parameters:
verify (object)
productId (Guid)

ShowLicenseValidationUi

#Since v6.0
bool ShowLicenseValidationUi(object verify, string cdkey)
Shows user interface to validate and register a license. Returns true if the license is successfully validated; false otherwise
Parameters:
verify (object)
cdkey (string)

ShowRhinoExpiredMessage

#Since v6.0
bool ShowRhinoExpiredMessage(Mode mode, ref int result)
Parameters:
mode (Mode)
result (ref int)