IZooClientUtilities

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

Properties

LoggedInUserAvatar

#Since v6.0
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.
Image LoggedInUserAvatar { get; }

LoggedInUserName

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

UserIsLoggedIn

#Since v6.0
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.
bool UserIsLoggedIn { get; }

Methods

AskUserForLicense

#Since v6.0
bool AskUserForLicense(
verify,
parameters
)

CheckInLicense

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

CheckOutLicense

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

ConvertLicense

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

DeleteLicense

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

Echo

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

GetCurrentTime

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

GetLicense

#Since v6.0
bool GetLicense(
verify,
parameters
)

GetLicenseStatus

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

GetLicenseType

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

GetOneLicenseStatus

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

GetRegisteredOwnerInfo

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

Initialize

#Since v6.0
bool Initialize(
verify
)

IsCheckOutEnabled

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

LicenseOptionsHandler

#Since v6.0
bool LicenseOptionsHandler(
verify,
parameters
)

LoginToCloudZoo

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

LogoutOfCloudZoo

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

ReturnLicense

#Since v6.0
bool ReturnLicense(
verify,
productId
)

ReturnLicense

#Since v6.0
bool ReturnLicense(
verify,
productPath,
productId
)

ShowBuyLicenseUi

#Since v6.0
void ShowBuyLicenseUi(
verify,
productId
)

ShowLicenseValidationUi

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

ShowRhinoExpiredMessage

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