InternalKeyManager

Method Summary
InternalKey	copyKey(InternalKey key, String name) Creates copy of this activation key
InternalKey	createActivationKey(String name, Data data) Creates a new InternalKey for the given enterprise with the specified settings.
InternalKey	createAffiliateActivationKey(String name, String inviteCode) Creates a new affiliate InternalKey for the given enterprise and store item.
InternalKey	createResellerActivationKey(String name, String inviteCode) Creates a new reseller InternalKey for the given enterprise and store item.
boolean	deleteActivationKey(String id) Deletes the specified key. The key must not be associated with any pals or transactions. Returns true on success.
InternalKey	getActivationKey(String id) Returns the InternalKey identified by id.
SystemDataView	getActivationKeys() Returns a view for accessing activation keys for this enterprise.
boolean	isActivationKeyNameUnique(String name) Returns true if the enterprise does not have an activation key with the given name.
boolean	setActivationKeyActive(String id) Sets the specified key to active. The key must have been approved for use.
boolean	setActivationKeyInActive(String id) Sets the specified key to inactive. The key must have been approved for use.
String	toString() Returns a description of this object.

Method Detail

InternalKey copyKey(InternalKey key, String name)

Creates copy of this activation key

Parameters:

InternalKey key - key to copy. Required parameter.
String name - new key name. Required parameter.

Returns: InternalKey

Since: 01-16-2012

top

InternalKey createActivationKey(String name, Data data)

Creates a new InternalKey for the given enterprise with the specified settings.

Parameters:

String name - activation key name. Required parameter. Maximum allowed size of parameter: 50
Data data

Returns: InternalKey

Since: 03-02-2010

top

InternalKey createAffiliateActivationKey(String name, String inviteCode)

Creates a new affiliate InternalKey for the given enterprise and store item.

Parameters:

String name - activation key name. Required parameter. Maximum allowed size of parameter: 50
String inviteCode Required parameter.

Returns: InternalKey

Since: 04-29-2010

top

InternalKey createResellerActivationKey(String name, String inviteCode)

Creates a new reseller InternalKey for the given enterprise and store item.

Parameters:

String name - activation key name. Required parameter. Maximum allowed size of parameter: 50
String inviteCode Required parameter.

Returns: InternalKey

Since: 04-29-2010

top

boolean deleteActivationKey(String id)

Deletes the specified key. The key must not be associated with any pals or transactions. Returns true on success.

Parameters:

String id Required parameter.

Returns: boolean

Since: 03-08-2010

top

InternalKey getActivationKey(String id)

Returns the InternalKey identified by id.

Parameters:

String id Required parameter.

Returns: InternalKey

Since: 03-02-2010

top

SystemDataView getActivationKeys()

Returns a view for accessing activation keys for this enterprise.

Returns: SystemDataView

DataList Name: Keys

DataList Keys/Column Name	Column Type	Read Only
id	String
name	String
createDate	Date
modifiedDate	Date
nextChangeDate	Date
nextChangeComment	String
storeEnabled	Boolean
repoEnabled	Boolean
authEnabled	Boolean
webEmailEnabled	Boolean
active	Boolean
status	String
pricingModel	String
pricingPlan	String
type	String

Since: 03-02-2010

top

boolean isActivationKeyNameUnique(String name)

Returns true if the enterprise does not have an activation key with the given name.

Parameters:

String name

Returns: boolean

Since: 03-02-2010

top

boolean setActivationKeyActive(String id)

Sets the specified key to active. The key must have been approved for use.

Parameters:

String id Required parameter.

Returns: boolean

Since: 03-22-2010

top

boolean setActivationKeyInActive(String id)

Sets the specified key to inactive. The key must have been approved for use.

Parameters:

String id Required parameter.

Returns: boolean

Since: 03-22-2010

top

String toString()

Returns a description of this object.

Returns: String

Since: 03-02-2010

top

API Date: Dec 03, 2024 10:24 AM