IlluminateSessionParams

java.lang.Object

com.digimarc.dms.session.IlluminateSessionParams

public class IlluminateSessionParams extends Object

Class represents the parameters required for an Illuminate session.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

IlluminateSessionParams.IlluminateContext

Enum represents different contexts for the Illuminate session.
Method Summary

Modifier and Type

Method

Description

IlluminateSessionParams

withAccessKey(String accessKey)

Sets the Mobile API key for the Illuminate session.

static IlluminateSessionParams

withAccountId(String accountId)

Creates a new IlluminateSessionParams instance with the given account ID.

IlluminateSessionParams

withContext(IlluminateSessionParams.IlluminateContext context)

Sets the context for the Illuminate session.

IlluminateSessionParams

withFields(List<String> fields)

Sets the fields for the Illuminate session.

IlluminateSessionParams

withSuppressedIlluminateCalls()

Suppresses Illuminate calls for the session.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- withAccountId
  
  public static IlluminateSessionParams withAccountId(String accountId)
  
  Creates a new IlluminateSessionParams instance with the given account ID.
  
  Parameters:
  
  accountId - the Illuminate account ID.
  
  Returns:
  
  a new IlluminateSessionParams instance.
- withFields
  
  public IlluminateSessionParams withFields(List<String> fields)
  
  Sets the fields for the Illuminate session. See the Illuminate Mobile API documentation for a list of available fields.
  
  Parameters:
  
  fields - the list of fields.
  
  Returns:
  
  the current IlluminateSessionParams instance.
- withAccessKey
  
  public IlluminateSessionParams withAccessKey(String accessKey)
  
  Sets the Mobile API key for the Illuminate session.
  
  Parameters:
  
  accessKey - the Mobile API key.
  
  Returns:
  
  the current IlluminateSessionParams instance.
- withSuppressedIlluminateCalls
  
  public IlluminateSessionParams withSuppressedIlluminateCalls()
  
  Suppresses Illuminate calls for the session.
  
  Returns:
  
  the current IlluminateSessionParams instance.
- withContext
  
  @NonNull public IlluminateSessionParams withContext(@NonNull IlluminateSessionParams.IlluminateContext context)
  
  Sets the context for the Illuminate session.
  
  Parameters:
  
  context -
  
  Returns:
  
  the current IlluminateSessionParams instance.