Class On_Image
- java.lang.Object
-
- ch.brix.gql.client.TypeBuilder
-
- ch.brix.gql.client.frontify.builders.On_Image
-
public class On_Image extends ch.brix.gql.client.TypeBuilder
-
-
Constructor Summary
Constructors Constructor Description On_Image()
-
Method Summary
Modifier and Type Method Description On_Imageattachments(Image_attachments callBuilder)`Attachment` items linked to `Asset`.On_Imageauthor()Represents the Author of the `Asset`.On_Imagecomments(Image_comments callBuilder)Paginated list of `AssetComment` items for `Asset`.On_Imagecopyright(Image_copyright callBuilder)`Asset` copyright details.On_ImagecreatedAt()`DateTime` of the `Asset` creation.On_Imagecreator(Image_creator callBuilder)The `User` who created the `Asset`.On_ImagecurrentUserPermissions(Image_currentUserPermissions callBuilder)Current `User` `Asset` permissions.On_ImagecustomMetadata(Image_customMetadata callBuilder)List of `CustomMetadataProperty` items and values associated to `Asset`.On_Imagedescription()Description of the `Asset`.On_ImagedownloadUrl(Image_downloadUrl callBuilder)Signed `Url` to download the original `Image` type file.On_ImageexpiresAt()`Asset` expiry date.On_Imageextension()Extension of the `Asset` `File`.On_ImageexternalId()External Id of the `Asset`.On_ImageexternalProducts(Image_externalProducts callBuilder)`ExternalProduct` items linked to `Asset`.On_Imagefilename()Original filename of the `Asset` `File`.On_ImagefocalPoint()`Image` focal point position.On_Imageheight()`Image` height in pixels.On_Imageid()`Asset` id.On_Imagelicenses(Image_licenses callBuilder)`License` items linked to `Asset`.On_ImagemetadataValues(Image_metadataValues callBuilder)Deprecated.On_ImagemodifiedAt()`DateTime` of the `Asset` last modification.On_Imagemodifier(Image_modifier callBuilder)The `User` who last modified the `Asset`.On_ImagepreviewUrl(Image_previewUrl callBuilder)Preview `Url` which has optional `width` and `height` URL parameters.On_ImagerelatedAssets(Image_relatedAssets callBuilder)Paginated list of `Asset` items related to `Asset`.On_Imagesize()Size of the `Asset` `File` in bytes.On_Imagestatus()Represents the conversion status of the `Asset`.On_Imagetags(Image_tags callBuilder)List of `Tag` items linked to `Asset`On_Imagetitle()Title of the `Asset`.On_Imagewidth()`Image` width in pixels.On_ImageworkflowTask(Image_workflowTask callBuilder)**BETA** The `WorkflowTask` this `Asset` is linked to.
-
-
-
Method Detail
-
id
public On_Image id()
`Asset` id.
-
creator
public On_Image creator(Image_creator callBuilder)
The `User` who created the `Asset`.
-
createdAt
public On_Image createdAt()
`DateTime` of the `Asset` creation.
-
modifier
public On_Image modifier(Image_modifier callBuilder)
The `User` who last modified the `Asset`.
-
modifiedAt
public On_Image modifiedAt()
`DateTime` of the `Asset` last modification.
-
title
public On_Image title()
Title of the `Asset`.
-
description
public On_Image description()
Description of the `Asset`.
-
attachments
public On_Image attachments(Image_attachments callBuilder)
`Attachment` items linked to `Asset`.
-
externalId
public On_Image externalId()
External Id of the `Asset`.
-
tags
public On_Image tags(Image_tags callBuilder)
List of `Tag` items linked to `Asset`
-
metadataValues
@Deprecated public On_Image metadataValues(Image_metadataValues callBuilder)
Deprecated.**DEPRECATED** `MetadataValue` items linked to `Asset`. This field will be removed. Use `customMetadata` instead. | Date: 2025-01-01T00:00:00.000+00:00 This field will be removed. Use `customMetadata` instead. | Date: 2025-01-01T00:00:00.000+00:00
-
externalProducts
public On_Image externalProducts(Image_externalProducts callBuilder)
`ExternalProduct` items linked to `Asset`.
-
copyright
public On_Image copyright(Image_copyright callBuilder)
`Asset` copyright details.
-
expiresAt
public On_Image expiresAt()
`Asset` expiry date.
-
licenses
public On_Image licenses(Image_licenses callBuilder)
`License` items linked to `Asset`.
-
author
public On_Image author()
Represents the Author of the `Asset`. Example: Photographer Name.
-
status
public On_Image status()
Represents the conversion status of the `Asset`. Example: FINISHED.
-
relatedAssets
public On_Image relatedAssets(Image_relatedAssets callBuilder)
Paginated list of `Asset` items related to `Asset`.
-
comments
public On_Image comments(Image_comments callBuilder)
Paginated list of `AssetComment` items for `Asset`.
-
currentUserPermissions
public On_Image currentUserPermissions(Image_currentUserPermissions callBuilder)
Current `User` `Asset` permissions.
-
customMetadata
public On_Image customMetadata(Image_customMetadata callBuilder)
List of `CustomMetadataProperty` items and values associated to `Asset`.
-
workflowTask
public On_Image workflowTask(Image_workflowTask callBuilder)
**BETA** The `WorkflowTask` this `Asset` is linked to.
-
filename
public On_Image filename()
Original filename of the `Asset` `File`.
-
size
public On_Image size()
Size of the `Asset` `File` in bytes.
-
extension
public On_Image extension()
Extension of the `Asset` `File`.
-
previewUrl
public On_Image previewUrl(Image_previewUrl callBuilder)
Preview `Url` which has optional `width` and `height` URL parameters. If parameters are not specified, `Url` without any URL parameters will be returned.
-
downloadUrl
public On_Image downloadUrl(Image_downloadUrl callBuilder)
Signed `Url` to download the original `Image` type file.
-
focalPoint
public On_Image focalPoint()
`Image` focal point position. Example: `[0.4803, 0.4340]`.
-
width
public On_Image width()
`Image` width in pixels.
-
height
public On_Image height()
`Image` height in pixels.
-
-