com.tle.web.scripting.advanced.objects
Interface DrmScriptObject
Declaration: public interface DrmScriptObject extends ScriptObject
All Superinterfaces: ScriptObject, java.io.Serializable

 

Referenced by the 'drm' variable in script.

 

 

Fields Summary
static java.lang.String DEFAULT_VARIABLE
    

 

 

Methods Summary
abstract DrmPartyScriptType createParty(java.lang.String name, java.lang.String emailAddress, boolean owner)
     Create a DRM Party for use in the DRMSettingsScriptType returned by getSettings()
abstract DrmPartyScriptType createPartyFromUserId(java.lang.String userId, boolean owner)
     Create a DRM Party for use in the DRMSettingsScriptType returned by getSettings()
abstract DrmSettingsScriptType getSettings()
    

 

Methods inherited from interface: com.tle.common.scripting.ScriptObject
scriptEnter, scriptExit

 

 

 

 

DEFAULT_VARIABLE

 

public static final java.lang.String DEFAULT_VARIABLE

 

See also: Constants

 

 

 

 

getSettings

 

public abstract DrmSettingsScriptType getSettings( )

 

Returns:
The DRM settings of the current item

 

 

 

createPartyFromUserId

 

public abstract DrmPartyScriptType createPartyFromUserId( java.lang.String userId,
boolean owner)

 

Create a DRM Party for use in the DRMSettingsScriptType returned by getSettings()

 

Parameters:
userId-
A user ID, either of an internal EQUELLA user or an externally authenticated user
owner-
Whether the party is an owner or not
Returns:
A populated DrmPartyScriptType

 

 

 

createParty

 

public abstract DrmPartyScriptType createParty( java.lang.String name,
java.lang.String emailAddress,
boolean owner)

 

Create a DRM Party for use in the DRMSettingsScriptType returned by getSettings()

 

Parameters:
name-
The display name of the party
emailAddress-
The email address of the party
owner-
Whether the party is an owner or not
Returns:
A DrmPartyScriptType populated from the supplied details