java.lang.Object
- ch.brix.gql.client.TypeBuilder
- - ch.brix.gql.client.frontify.builders.On_Document

public class On_Document
extends ch.brix.gql.client.TypeBuilder

Constructor Summary

Constructors
Constructor Description

On_Document()

Method Summary

Modifier and Type	Method	Description
`On_Document`	`alternativeText()`	Alternative text for the `Asset`.
`On_Document`	`attachments(Document_attachments callBuilder)`	`Attachment` items linked to `Asset`.
`On_Document`	`author()`	Represents the Author of the `Asset`.
`On_Document`	`availability(Document_availability callBuilder)`	BETA `Asset` will be available only during the defined `DateTime` range.When `null` it represents an unspecified start and/or open-ended date.
`On_Document`	`comments(Document_comments callBuilder)`	Paginated list of `AssetComment` items for `Asset`.
`On_Document`	`copyright(Document_copyright callBuilder)`	`Asset` copyright details.
`On_Document`	`createdAt()`	`DateTime` of the `Asset` creation.
`On_Document`	`creator(Document_creator callBuilder)`	The `User` who created the `Asset`.
`On_Document`	`currentUserPermissions(Document_currentUserPermissions callBuilder)`	Current `User` `Asset` permissions.
`On_Document`	`customMetadata(Document_customMetadata callBuilder)`	List of `CustomMetadataProperty` items and values associated to `Asset`.
`On_Document`	`description()`	Description of the `Asset`.
`On_Document`	`downloadUrl(Document_downloadUrl callBuilder)`	Signed `Url` to download the original `Document` type file.
`On_Document`	`expiresAt()`	`Asset` available until date.
`On_Document`	`extension()`	Extension of the `Asset` `File`.
`On_Document`	`externalId()`	External Id of the `Asset`.
`On_Document`	`externalProducts(Document_externalProducts callBuilder)`	Deprecated.
`On_Document`	`fileCreatedAt()`	`DateTime` of the `Asset` `File` creation.
`On_Document`	`filename()`	Original filename of the `Asset` `File`.
`On_Document`	`focalPoint()`	`Document` focal point position.
`On_Document`	`height()`	`Document` height in pixels.
`On_Document`	`id()`	`Asset` id.
`On_Document`	`isDecorative()`	BETA Indicates whether the `Asset` is decorative and not meant to be read by screen readers.
`On_Document`	`licenses(Document_licenses callBuilder)`	`License` items linked to `Asset`.
`On_Document`	`location(Document_location callBuilder)`	`Location` of the `Asset`.
`On_Document`	`metadataValues(Document_metadataValues callBuilder)`	Deprecated.
`On_Document`	`modifiedAt()`	`DateTime` of the `Asset` last modification.
`On_Document`	`modifier(Document_modifier callBuilder)`	The `User` who last modified the `Asset`.
`On_Document`	`pageCount()`	`Document` total number of pages.
`On_Document`	`previewBackgroundColor(Document_previewBackgroundColor callBuilder)`	BETA Background color of the `Asset` preview.
`On_Document`	`previewUrl(Document_previewUrl callBuilder)`	Preview `Url` which has optional `width`, `height` and `page` arguments.
`On_Document`	`relatedAssets(Document_relatedAssets callBuilder)`	Paginated list of `Asset` items related to `Asset`.
`On_Document`	`size()`	Size of the `Asset` `File` in bytes.
`On_Document`	`status()`	Represents the conversion status of the `Asset`.
`On_Document`	`tags(Document_tags callBuilder)`	List of `Tag` items linked to `Asset`
`On_Document`	`thumbnailUrl()`	Provides a `Url` for the custom user defined thumbnail or a system generated one when possible.
`On_Document`	`title()`	Title of the `Asset`.
`On_Document`	`width()`	`Document` width in pixels.
`On_Document`	`workflowTask(Document_workflowTask callBuilder)`	BETA The `WorkflowTask` this `Asset` is linked to.

Methods inherited from class ch.brix.gql.client.TypeBuilder
_add_call, _add_field

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

- Constructor Detail
  - On_Document
```
public On_Document()
```
- Method Detail
  - id
```
public On_Document id()
```
    `Asset` id.
  - creator
```
public On_Document creator(Document_creator callBuilder)
```
    The `User` who created the `Asset`.
  - createdAt
```
public On_Document createdAt()
```
    `DateTime` of the `Asset` creation.
  - modifier
```
public On_Document modifier(Document_modifier callBuilder)
```
    The `User` who last modified the `Asset`.
  - modifiedAt
```
public On_Document modifiedAt()
```
    `DateTime` of the `Asset` last modification.
  - title
```
public On_Document title()
```
    Title of the `Asset`.
  - description
```
public On_Document description()
```
    Description of the `Asset`.
  - alternativeText
```
public On_Document alternativeText()
```
    Alternative text for the `Asset`. Used by screen readers when the asset is not decorative.
  - isDecorative
```
public On_Document isDecorative()
```
    **BETA** Indicates whether the `Asset` is decorative and not meant to be read by screen readers. If true, alternative text is ignored.
  - attachments
```
public On_Document attachments(Document_attachments callBuilder)
```
    `Attachment` items linked to `Asset`.
  - externalId
```
public On_Document externalId()
```
    External Id of the `Asset`.
  - tags
```
public On_Document tags(Document_tags callBuilder)
```
    List of `Tag` items linked to `Asset`
  - metadataValues
```
@Deprecated
public On_Document metadataValues(Document_metadataValues callBuilder)
```
    Deprecated.
    
    **DEPRECATED** `MetadataValue` items linked to `Asset`. This field will be removed. Use `customMetadata` instead. | Date: 2025-07-01T00:00:00.000+00:00 This field will be removed. Use `customMetadata` instead. | Date: 2025-07-01T00:00:00.000+00:00
  - externalProducts
```
@Deprecated
public On_Document externalProducts(Document_externalProducts callBuilder)
```
    Deprecated.
    
    **DEPRECATED** `ExternalProduct` items linked to `Asset`. This field will be removed. | Date: 2025-01-01T00:00:00.000+00:00 This field will be removed. | Date: 2025-01-01T00:00:00.000+00:00
  - copyright
```
public On_Document copyright(Document_copyright callBuilder)
```
    `Asset` copyright details.
  - availability
```
public On_Document availability(Document_availability callBuilder)
```
    **BETA** `Asset` will be available only during the defined `DateTime` range.When `null` it represents an unspecified start and/or open-ended date.
  - expiresAt
```
public On_Document expiresAt()
```
    `Asset` available until date.
  - licenses
```
public On_Document licenses(Document_licenses callBuilder)
```
    `License` items linked to `Asset`.
  - author
```
public On_Document author()
```
    Represents the Author of the `Asset`. Example: Photographer Name.
  - status
```
public On_Document status()
```
    Represents the conversion status of the `Asset`. Example: FINISHED.
  - relatedAssets
```
public On_Document relatedAssets(Document_relatedAssets callBuilder)
```
    Paginated list of `Asset` items related to `Asset`.
  - comments
```
public On_Document comments(Document_comments callBuilder)
```
    Paginated list of `AssetComment` items for `Asset`.
  - currentUserPermissions
```
public On_Document currentUserPermissions(Document_currentUserPermissions callBuilder)
```
    Current `User` `Asset` permissions.
  - customMetadata
```
public On_Document customMetadata(Document_customMetadata callBuilder)
```
    List of `CustomMetadataProperty` items and values associated to `Asset`.
  - workflowTask
```
public On_Document workflowTask(Document_workflowTask callBuilder)
```
    **BETA** The `WorkflowTask` this `Asset` is linked to.
  - location
```
public On_Document location(Document_location callBuilder)
```
    `Location` of the `Asset`.
  - previewBackgroundColor
```
public On_Document previewBackgroundColor(Document_previewBackgroundColor callBuilder)
```
    **BETA** Background color of the `Asset` preview.
  - filename
```
public On_Document filename()
```
    Original filename of the `Asset` `File`.
  - size
```
public On_Document size()
```
    Size of the `Asset` `File` in bytes.
  - extension
```
public On_Document extension()
```
    Extension of the `Asset` `File`.
  - fileCreatedAt
```
public On_Document fileCreatedAt()
```
    `DateTime` of the `Asset` `File` creation.
  - previewUrl
```
public On_Document previewUrl(Document_previewUrl callBuilder)
```
    Preview `Url` which has optional `width`, `height` and `page` arguments. If parameters are not specified, a `Url` without any parameters will be returned.
  - thumbnailUrl
```
public On_Document thumbnailUrl()
```
    Provides a `Url` for the custom user defined thumbnail or a system generated one when possible.
  - downloadUrl
```
public On_Document downloadUrl(Document_downloadUrl callBuilder)
```
    Signed `Url` to download the original `Document` type file.
  - focalPoint
```
public On_Document focalPoint()
```
    `Document` focal point position. Example: `[0.4803, 0.4340]`.
  - width
```
public On_Document width()
```
    `Document` width in pixels.
  - height
```
public On_Document height()
```
    `Document` height in pixels.
  - pageCount
```
public On_Document pageCount()
```
    `Document` total number of pages.

Class On_Document

Constructor Summary

Method Summary

Methods inherited from class ch.brix.gql.client.TypeBuilder

Methods inherited from class java.lang.Object

Constructor Detail

On_Document

Method Detail

id

creator

createdAt

modifier

modifiedAt

title

description

alternativeText

isDecorative

attachments

externalId

tags

metadataValues

externalProducts

copyright

availability

expiresAt

licenses

author

status

relatedAssets

comments

currentUserPermissions

customMetadata

workflowTask

location

previewBackgroundColor

filename

size

extension

fileCreatedAt

previewUrl

thumbnailUrl

downloadUrl

focalPoint

width

height

pageCount