DSpace.API.File.FormatRegistry (dspace_ex v0.1.0-alpha2)

Copy Markdown View Source

Provides functions to access and write the File format registry.

Summary

Functions

create(format, options \\ [])

Creates a new file format in the registry.

delete(id, options \\ [])

Deletes a file format.

fetch(id, options \\ [])

Fetches a single file format by ID.

list(options \\ [])

Lists the file formats defined in the registry.

replace(id, format, options \\ [])

Replaces an existing file format in the registry.

Functions

create(format, options \\ [])

@spec create(
  map(),
  keyword()
) :: DSpace.API.Operation.t()

Creates a new file format in the registry.

This operation requires administrator privileges.

delete(id, options \\ [])

@spec delete(
  non_neg_integer(),
  keyword()
) :: DSpace.API.Operation.t()

Deletes a file format.

fetch(id, options \\ [])

@spec fetch(
  non_neg_integer(),
  keyword()
) :: DSpace.API.Operation.t()

Fetches a single file format by ID.

list(options \\ [])

@spec list(keyword()) :: DSpace.API.Operation.JSON.t()

Lists the file formats defined in the registry.

This operation can be streamed.

Options

  • :page - Page number (0-based, defaults to 0)
  • :size - Number of items per page (usually defaults to 20)

replace(id, format, options \\ [])

@spec replace(non_neg_integer(), map(), keyword()) :: DSpace.API.Operation.t()

Replaces an existing file format in the registry.