Skip to main content

File

No description

type File implements Node {
  id: ID!
  namespaceId: ID!
  namespace: Namespace!
  owner: String
  created: DateTime!
  updated: DateTime!
  archivedAt: DateTime
  size: BigInt!
  md5Hash: String!
  location: URL!
  mime: Mime!
  nature: FileNature!
  originalName: String
  derivedFrom: File
  representations: [FileRepresentation!]!
  relatedEntities: [Entity!]!
  customAttributes: [Attribute!]!
  signedURL(
  expires: DateTime!
  webReaderProtection: Boolean
): SignedLink
}

Fields​

File.id ● ID! non-null scalar​

The ID of the file.

File.namespaceId ● ID! non-null scalar​

The ID of the file's namespace.

File.namespace ● Namespace! non-null object​

The file's namespace.

File.owner ● String scalar​

A string identifying the owner/uploader of the file.

File.created ● DateTime! non-null scalar​

The date and time at which the file was first created.

File.updated ● DateTime! non-null scalar​

The date and time at which the file was last updated.

File.archivedAt ● DateTime scalar​

The date and time at which the file was archived.

File.size ● BigInt! non-null scalar​

The file size in bytes.

File.md5Hash ● String! non-null scalar​

The md5 digest of the file's content, base16 encoded.

File.location ● URL! non-null scalar​

A URL to the file's storage location.

File.mime ● Mime! non-null scalar​

The file's RFC6838-encoded media type.

File.nature ● FileNature! non-null enum​

The nature/purpose of the file.

File.originalName ● String scalar​

The name the file had when it was first put into the system.

File.derivedFrom ● File object​

The file from which this one was derived from. In the case of a generated sample for example.

File.representations ● [FileRepresentation!]! non-null interface​

The various reprensentations of the file. For example, an LCP package and a Cloudflare Image.

File.relatedEntities ● [Entity!]! non-null union​

The entities (Publication, License, etc.) referenced by or linked to the file.

File.customAttributes ● [Attribute!]! non-null object​

A list of non typed attributes.

File.signedURL ● SignedLink object​

A time limited signed URL for any given file.

File.signedURL.expires ● DateTime! non-null scalar​

When should that link expire. It should always be in the future.

File.signedURL.webReaderProtection ● Boolean scalar​

Whether or not to use the WebReader protection (only accepts range requests and binary-not the content). False by default.

Interfaces​

Node interface​

An object with an ID.

Returned by​

archivedFile query ● createFile mutation ● file query

Member of​

File object ● FileEdge object