Package ch.brix.gql.client.frontify.builders

Class On_Image

  • public class On_Image
extends ch.brix.gql.client.TypeBuilder

    • Constructor Detail

      • On_Image

        public On_Image()

    • Method Detail

      • 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`.

      • alternativeText

        public On_Image alternativeText()
        Alternative text for the `Asset`. Used by screen readers when the asset is not decorative.

      • isDecorative

        public On_Image isDecorative()
        **BETA** Indicates whether the `Asset` is decorative and not meant to be read by screen readers. If true, alternative text is ignored.

      • 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-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_Image externalProducts​(Image_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

      • availability

        public On_Image availability​(Image_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_Image expiresAt()
        `Asset` available until date.

      • 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`.

      • 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`.

      • fileCreatedAt

        public On_Image fileCreatedAt()
        `DateTime` of the `Asset` `File` creation.

      • 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.

      • thumbnailUrl

        public On_Image thumbnailUrl()
        Provides a `Url` for the custom user defined thumbnail or a system generated one when possible.

      • 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.