Packages

class AdminApi extends HttpSupport with DebugEnhancedLogging

Linear Supertypes
HttpSupport, DebugEnhancedLogging, LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AdminApi
  2. HttpSupport
  3. DebugEnhancedLogging
  4. LazyLogging
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addBannerMessage(bannerMessage: BannerMessage): Try[DataverseResponse[DataMessage]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#manage-banner-messages

  5. def addBannerMessage(bannerMessage: String): Try[DataverseResponse[DataMessage]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#manage-banner-messages

  6. def addWorkflow(json: String): Try[DataverseResponse[Workflow]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  7. def addWorkflow(workflow: Workflow): Try[DataverseResponse[Workflow]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  8. val apiPrefix: String
    Attributes
    protected
    Definition Classes
    AdminApi → HttpSupport
  9. val apiToken: Option[String]
    Attributes
    protected
    Definition Classes
    AdminApi → HttpSupport
  10. val apiVersion: Option[String]
    Attributes
    protected
    Definition Classes
    AdminApi → HttpSupport
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. val baseUrl: URI
    Attributes
    protected
    Definition Classes
    AdminApi → HttpSupport
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. val connectionTimeout: Int
    Attributes
    protected
    Definition Classes
    AdminApi → HttpSupport
  15. def deactivateBannerMessage(id: Int): Try[DataverseResponse[DataMessage]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#manage-banner-messages

  16. def debug(msg: String)(implicit enclosing: Name): Unit
    Definition Classes
    DebugEnhancedLogging
  17. def deleteBannerMessage(id: Int): Try[DataverseResponse[DataMessage]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#manage-banner-messages

  18. def deleteDatabaseSetting(settingName: String): Try[DataverseResponse[Nothing]]

    settingName

    the name of the setting

    See also

    https://guides.dataverse.org/en/latest/installation/config.html#database-settings

  19. def deletePath[D](subPath: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  20. def deleteWorkflow(id: Int): Try[DataverseResponse[DataMessage]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def get[D](subPath: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def getDatabaseSetting(settingName: String): Try[DataverseResponse[DataMessage]]

    settingName

    the name of the setting

    returns

    the current value

    See also

    https://guides.dataverse.org/en/latest/installation/config.html#database-settings

  27. def getDefaultWorkflow(triggerType: String): Try[DataverseResponse[Workflow]]

    triggerType

    PrePublishDataset or PostPublishDataset

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  28. def getDefaultWorkflows: Try[DataverseResponse[Map[String, Workflow]]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  29. def getSingleUser(id: String): Try[DataverseResponse[AuthenticatedUser]]

    Returns the account data for a single user.

    Returns the account data for a single user.

    id

    the user ID

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#list-single-user

  30. def getStorageDrivers: Try[DataverseResponse[Map[String, String]]]

    See also

    https://guides.dataverse.org/en/latest/admin/dataverses-datasets.html#configure-a-dataset-to-store-all-new-files-in-a-specific-file-store

  31. def getUnwrapped(subPath: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty): Try[HttpResponse[Array[Byte]]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  32. def getWorkflow(id: Int): Try[DataverseResponse[Workflow]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  33. def getWorkflows: Try[DataverseResponse[List[Workflow]]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  34. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. def listBannerMessages(): Try[DataverseResponse[List[DisplayedText]]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#manage-banner-messages

  37. def listDatabaseSettings(): Try[DataverseResponse[Map[String, String]]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#list-all-database-settings

  38. lazy val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
    Annotations
    @transient()
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. def postFile[D](subPath: String, optFile: Option[File], optJsonMetadata: Option[String] = Option.empty, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Posts a multi-part message with an optional file and optional JSON metadata part.

    Posts a multi-part message with an optional file and optional JSON metadata part. Probably at least one is required, but since this is an internal function, this is not validated.

    D

    the payload type for the DataverseResponse

    subPath

    subpath to post to

    optFile

    the optional file

    optJsonMetadata

    the optional metadata

    headers

    extra headers

    params

    extra query parameters

    returns

    a DataverseResponse

    Attributes
    protected
    Definition Classes
    HttpSupport
  43. def postJson[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty, isJsonLd: Boolean = false)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  44. def postText[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  45. def put[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  46. def putDatabaseSetting(settingName: String, value: Boolean): Try[DataverseResponse[DatabaseSetting]]

    settingName

    the name of the setting

    value

    the boolean value to set

    See also

    https://guides.dataverse.org/en/latest/installation/config.html#database-settings

  47. def putDatabaseSetting(settingName: String, value: String): Try[DataverseResponse[DatabaseSetting]]

    settingName

    the name of the setting

    value

    the value to set

    See also

    https://guides.dataverse.org/en/latest/installation/config.html#database-settings

  48. def putJson[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty, isJsonLd: Boolean = false)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]
    Attributes
    protected
    Definition Classes
    HttpSupport
  49. val readTimeout: Int
    Attributes
    protected
    Definition Classes
    AdminApi → HttpSupport
  50. val sendApiTokenViaBasicAuth: Boolean
    Attributes
    protected
    Definition Classes
    AdminApi → HttpSupport
  51. def setDefaultWorkflow(triggerType: String, workflowId: Int): Try[DataverseResponse[DataMessage]]

    triggerType

    PrePublishDataset or PostPublishDataset

    workflowId

    id of the workflow to make default

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  52. def setWorkflowsWhitelist(ips: List[String]): Try[DataverseResponse[Any]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  53. def setWorkflowsWhitelist(whilelist: String): Try[DataverseResponse[Any]]

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  54. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. def trace[V](value: Text[V])(implicit enclosing: Name): Unit
    Definition Classes
    DebugEnhancedLogging
  57. val unblockKey: Option[String]
    Attributes
    protected
    Definition Classes
    AdminApi → HttpSupport
  58. def unsetDefaultWorkflow(triggerType: String): Try[DataverseResponse[DataMessage]]

    triggerType

    PrePublishDataset or PostPublishDataset

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#workflows

  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from HttpSupport

Inherited from DebugEnhancedLogging

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped