Class MetaClient

Inheritance
Object
MetaClient
Implements
Inherited Members
Namespace: PKWARE.Smartcrypt.MetaClient
Assembly: MetaClient.dll
Syntax
public sealed class MetaClient : IMetaClient

Properties

CryptoProvider

Declaration
public ICryptoProvider CryptoProvider { get; }
Property Value
Type Description
ICryptoProvider

IsolatedMode

Declaration
public bool IsolatedMode { get; set; }
Property Value
Type Description
Boolean

Logger

Declaration
public Logger Logger { get; }
Property Value
Type Description
Logger

Methods

ApplyContingencyGroup(String)

Declaration
public EncryptionInfo ApplyContingencyGroup(string sessionKey)
Parameters
Type Name Description
String sessionKey
Returns
Type Description
EncryptionInfo

askForAsset(String)

Declaration
public void askForAsset(string jsonOrUrn)
Parameters
Type Name Description
String jsonOrUrn

canCreateKey(String)

Declaration
public bool canCreateKey(string kind)
Parameters
Type Name Description
String kind
Returns
Type Description
Boolean

CanRecoveryBePerformed()

Declaration
public bool CanRecoveryBePerformed()
Returns
Type Description
Boolean

canUseUnmanagedAccount()

Declaration
public bool canUseUnmanagedAccount()
Returns
Type Description
Boolean

ChangeEmail(String)

Declaration
public void ChangeEmail(string value)
Parameters
Type Name Description
String value

ChangeName(String)

Declaration
public void ChangeName(string value)
Parameters
Type Name Description
String value

ChangePassword(String, String)

Declaration
public void ChangePassword(string oldPassword, string newPassword)
Parameters
Type Name Description
String oldPassword
String newPassword

changesWereNotSaved()

Declaration
public void changesWereNotSaved()

ChangeUrl(String)

Declaration
public void ChangeUrl(string value)
Parameters
Type Name Description
String value

CreateAccount(String, String, String)

Declaration
public void CreateAccount(string email, string name, string password)
Parameters
Type Name Description
String email
String name
String password

CreateSatelliteServerAccount(String, String, String, String, String)

Declaration
public void CreateSatelliteServerAccount(string email, string name, string url, string password, string licenseRequest)
Parameters
Type Name Description
String email
String name
String url
String password
String licenseRequest

DecryptV2(String)

Declaration
public byte[] DecryptV2(string data)
Parameters
Type Name Description
String data
Returns
Type Description
Byte[]

DecryptV3(String)

Declaration
public byte[] DecryptV3(string data)
Parameters
Type Name Description
String data
Returns
Type Description
Byte[]

DeleteAppDatum(String, String)

Declaration
public void DeleteAppDatum(string kind, string name)
Parameters
Type Name Description
String kind
String name

EncryptAccountPassword(String)

Declaration
public string EncryptAccountPassword(string accountPassword)
Parameters
Type Name Description
String accountPassword
Returns
Type Description
String
Exceptions
Type Condition
MetaClientException

GET(String)

Declaration
public string GET(string suffix)
Parameters
Type Name Description
String suffix
Returns
Type Description
String

GetApplicationStatus(String, String, String)

Declaration
public ApplicationStatus GetApplicationStatus(string kind, string version, string referenceUrn)
Parameters
Type Name Description
String kind
String version
String referenceUrn
Returns
Type Description
ApplicationStatus

GetArchiveDecryptionPassword(String)

Declaration
public string GetArchiveDecryptionPassword(string jsonOrUrn)
Parameters
Type Name Description
String jsonOrUrn
Returns
Type Description
String

GetClusterServers()

Declaration
public IEnumerable<string> GetClusterServers()
Returns
Type Description
IEnumerable<String>

GetEntitlement(String, String)

Declaration
public string GetEntitlement(string name, string defaultValue)
Parameters
Type Name Description
String name
String defaultValue
Returns
Type Description
String

GetManagedAesKey(String)

Declaration
public IManagedAesKey GetManagedAesKey(string serialized)
Parameters
Type Name Description
String serialized
Returns
Type Description
IManagedAesKey

GetManagedAesKeys()

Declaration
public IEnumerable<ISingleAssetManager> GetManagedAesKeys()
Returns
Type Description
IEnumerable<ISingleAssetManager>

GetNotifications()

Declaration
public ISet<Notification> GetNotifications()
Returns
Type Description
ISet<Notification>

getPassword()

Declaration
[CanBeNull]
public string getPassword()
Returns
Type Description
String

getPrefix()

Declaration
public string getPrefix()
Returns
Type Description
String

GetPublicKey()

Declaration
public string GetPublicKey()
Returns
Type Description
String

GetSyncInterval()

Declaration
public TimeSpan GetSyncInterval()
Returns
Type Description
TimeSpan

getUserEmail()

Declaration
public string getUserEmail()
Returns
Type Description
String

getUserETag()

Declaration
public int getUserETag()
Returns
Type Description
Int32

getUserId()

Declaration
public long getUserId()
Returns
Type Description
Int64

getUserName()

Declaration
public string getUserName()
Returns
Type Description
String

getUserURN()

Declaration
public string getUserURN()
Returns
Type Description
String

getXPIDs()

Declaration
public IList<KnownUser> getXPIDs()
Returns
Type Description
IList<KnownUser>

isAccountAllowed()

Declaration
public bool isAccountAllowed()
Returns
Type Description
Boolean

IsAccountManaged(String)

Declaration
public bool IsAccountManaged(string email)
Parameters
Type Name Description
String email
Returns
Type Description
Boolean

isAuthenticated()

Declaration
public bool isAuthenticated()
Returns
Type Description
Boolean

isDeviceAllowed()

Declaration
public bool isDeviceAllowed()
Returns
Type Description
Boolean

isLicensed()

Declaration
public bool isLicensed()
Returns
Type Description
Boolean
Exceptions
Type Condition
MetaClientException

isLoggedIn()

Declaration
public bool isLoggedIn()
Returns
Type Description
Boolean

isManagedAccount()

Declaration
public bool isManagedAccount()
Returns
Type Description
Boolean

isOfflineAccessExpired()

Declaration
public bool isOfflineAccessExpired()
Returns
Type Description
Boolean

isRegistered()

Declaration
public bool isRegistered()
Returns
Type Description
Boolean

isSatellite()

Declaration
public bool isSatellite()
Returns
Type Description
Boolean

Login(String, String, String)

Declaration
public void Login(string email, string password, string oldPassword)
Parameters
Type Name Description
String email
String password
String oldPassword

LoginImplicitAccount()

Declaration
public void LoginImplicitAccount()
Exceptions
Type Condition
MetaClientException

With Category of CategoryUpgrade if the data are newer than understood by this software. With Category of CategoryInternal if the data are in an invalid format.

LoginManagedAccount(String, String)

Declaration
public void LoginManagedAccount(string emailWithHost, string accountPassword)
Parameters
Type Name Description
String emailWithHost
String accountPassword

LoginManagedAccountEncPass(String, String)

Declaration
public void LoginManagedAccountEncPass(string emailWithHost, string encryptedAccountPassword)
Parameters
Type Name Description
String emailWithHost
String encryptedAccountPassword

Logout()

Declaration
public void Logout()

lookupUsers(IList<String>)

Declaration
public IList<KnownUser> lookupUsers(IList<string> emails)
Parameters
Type Name Description
IList<String> emails
Returns
Type Description
IList<KnownUser>

migrate(String, String, String, Boolean)

Declaration
public void migrate(string email, string password, string accountPassword, bool mfaExpected)
Parameters
Type Name Description
String email
String password
String accountPassword
Boolean mfaExpected

POST(String, String)

Declaration
public string POST(string suffix, string text)
Parameters
Type Name Description
String suffix
String text
Returns
Type Description
String

ProcessIsolatedUpdate(String)

Declaration
public void ProcessIsolatedUpdate(string blob)
Parameters
Type Name Description
String blob

RecoverPassword(String, Boolean, String)

Declaration
public string RecoverPassword(string recoveryToken, bool mfaExpected, string recoveryCipher)
Parameters
Type Name Description
String recoveryToken
Boolean mfaExpected
String recoveryCipher
Returns
Type Description
String

RequestAccess(String)

Declaration
public void RequestAccess(string serialized)
Parameters
Type Name Description
String serialized

requestEmailVerification()

Declaration
public void requestEmailVerification()

requestMFARemoval(String, String)

Declaration
public void requestMFARemoval(string email, string password)
Parameters
Type Name Description
String email
String password
Remarks

Can be called without being logged in.

Exceptions
Type Condition
MetaClientException

RequestRecoveryEmail(String)

Declaration
public void RequestRecoveryEmail(string email)
Parameters
Type Name Description
String email

RespondToNotification(String, String)

Declaration
public void RespondToNotification(string urn, string action)
Parameters
Type Name Description
String urn
String action

RestoreAll(IDictionary<String, String>)

Declaration
public void RestoreAll(IDictionary<string, string> serials)
Parameters
Type Name Description
IDictionary<String, String> serials

SaveAppData(String, String, String)

Declaration
public void SaveAppData(string kind, string name, string value)
Parameters
Type Name Description
String kind
String name
String value

SerializeAll(Boolean)

Declaration
public IDictionary<string, string> SerializeAll(bool incremental)
Parameters
Type Name Description
Boolean incremental
Returns
Type Description
IDictionary<String, String>

setMFAToken(String)

Declaration
public void setMFAToken(string token)
Parameters
Type Name Description
String token

SetServer(String)

Declaration
public void SetServer(string url)
Parameters
Type Name Description
String url

SetStat(String, String, Int64)

Declaration
public void SetStat(string kind, string qualifier, long value)
Parameters
Type Name Description
String kind
String qualifier
Int64 value

shouldPersistCredentials()

Declaration
public bool shouldPersistCredentials()
Returns
Type Description
Boolean

Sign(String)

Declaration
public string Sign(string data)
Parameters
Type Name Description
String data
Returns
Type Description
String

SwitchToCentral(String)

Declaration
public void SwitchToCentral(string prefix)
Parameters
Type Name Description
String prefix

switchToDomain(String)

Declaration
public bool switchToDomain(string domainOrEmail)
Parameters
Type Name Description
String domainOrEmail
Returns
Type Description
Boolean

sync()

Declaration
public void sync()

WrapSessionKeyWithSmartkey(String, String)

Declaration
public EncryptionInfo WrapSessionKeyWithSmartkey(string smartkeyUrn, string sessionKey)
Parameters
Type Name Description
String smartkeyUrn
String sessionKey
Returns
Type Description
EncryptionInfo

Implements

Extension Methods