Class On_EmbeddedContent
- java.lang.Object
-
- ch.brix.gql.client.TypeBuilder
-
- ch.brix.gql.client.frontify.builders.On_EmbeddedContent
-
public class On_EmbeddedContent extends ch.brix.gql.client.TypeBuilder
-
-
Constructor Summary
Constructors Constructor Description On_EmbeddedContent()
-
Method Summary
Modifier and Type Method Description On_EmbeddedContentalternativeText()Alternative text for the `Asset`.On_EmbeddedContentattachments(EmbeddedContent_attachments callBuilder)`Attachment` items linked to `Asset`.On_EmbeddedContentauthor()Represents the Author of the `Asset`.On_EmbeddedContentavailability(EmbeddedContent_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_EmbeddedContentcomments(EmbeddedContent_comments callBuilder)Paginated list of `AssetComment` items for `Asset`.On_EmbeddedContentcopyright(EmbeddedContent_copyright callBuilder)`Asset` copyright details.On_EmbeddedContentcreatedAt()`DateTime` of the `Asset` creation.On_EmbeddedContentcreator(EmbeddedContent_creator callBuilder)The `User` who created the `Asset`.On_EmbeddedContentcurrentUserPermissions(EmbeddedContent_currentUserPermissions callBuilder)Current `User` `Asset` permissions.On_EmbeddedContentcustomMetadata(EmbeddedContent_customMetadata callBuilder)List of `CustomMetadataProperty` items and values associated to `Asset`.On_EmbeddedContentdescription()Description of the `Asset`.On_EmbeddedContentexpiresAt()`Asset` available until date.On_EmbeddedContentexternalId()External Id of the `Asset`.On_EmbeddedContentexternalProducts(EmbeddedContent_externalProducts callBuilder)Deprecated.On_EmbeddedContentid()`Asset` id.On_EmbeddedContentisDecorative()**BETA** Indicates whether the `Asset` is decorative and not meant to be read by screen readers.On_EmbeddedContentlicenses(EmbeddedContent_licenses callBuilder)`License` items linked to `Asset`.On_EmbeddedContentlocation(EmbeddedContent_location callBuilder)`Location` of the `Asset`.On_EmbeddedContentmetadataValues(EmbeddedContent_metadataValues callBuilder)Deprecated.On_EmbeddedContentmodifiedAt()`DateTime` of the `Asset` last modification.On_EmbeddedContentmodifier(EmbeddedContent_modifier callBuilder)The `User` who last modified the `Asset`.On_EmbeddedContentpreviewBackgroundColor(EmbeddedContent_previewBackgroundColor callBuilder)**BETA** Background color of the `Asset` preview.On_EmbeddedContentpreviewUrl()Preview of the embedded content.On_EmbeddedContentrelatedAssets(EmbeddedContent_relatedAssets callBuilder)Paginated list of `Asset` items related to `Asset`.On_EmbeddedContentstatus()Represents the conversion status of the `Asset`.On_EmbeddedContenttags(EmbeddedContent_tags callBuilder)List of `Tag` items linked to `Asset`On_EmbeddedContentthumbnailUrl()Provides a `Url` for the custom user defined thumbnail or a system generated one when possible.On_EmbeddedContenttitle()Title of the `Asset`.On_EmbeddedContentworkflowTask(EmbeddedContent_workflowTask callBuilder)**BETA** The `WorkflowTask` this `Asset` is linked to.
-
-
-
Method Detail
-
id
public On_EmbeddedContent id()
`Asset` id.
-
creator
public On_EmbeddedContent creator(EmbeddedContent_creator callBuilder)
The `User` who created the `Asset`.
-
createdAt
public On_EmbeddedContent createdAt()
`DateTime` of the `Asset` creation.
-
modifier
public On_EmbeddedContent modifier(EmbeddedContent_modifier callBuilder)
The `User` who last modified the `Asset`.
-
modifiedAt
public On_EmbeddedContent modifiedAt()
`DateTime` of the `Asset` last modification.
-
title
public On_EmbeddedContent title()
Title of the `Asset`.
-
description
public On_EmbeddedContent description()
Description of the `Asset`.
-
alternativeText
public On_EmbeddedContent alternativeText()
Alternative text for the `Asset`. Used by screen readers when the asset is not decorative.
-
isDecorative
public On_EmbeddedContent 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_EmbeddedContent attachments(EmbeddedContent_attachments callBuilder)
`Attachment` items linked to `Asset`.
-
externalId
public On_EmbeddedContent externalId()
External Id of the `Asset`.
-
tags
public On_EmbeddedContent tags(EmbeddedContent_tags callBuilder)
List of `Tag` items linked to `Asset`
-
metadataValues
@Deprecated public On_EmbeddedContent metadataValues(EmbeddedContent_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_EmbeddedContent externalProducts(EmbeddedContent_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_EmbeddedContent copyright(EmbeddedContent_copyright callBuilder)
`Asset` copyright details.
-
availability
public On_EmbeddedContent availability(EmbeddedContent_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_EmbeddedContent expiresAt()
`Asset` available until date.
-
licenses
public On_EmbeddedContent licenses(EmbeddedContent_licenses callBuilder)
`License` items linked to `Asset`.
-
author
public On_EmbeddedContent author()
Represents the Author of the `Asset`. Example: Photographer Name.
-
status
public On_EmbeddedContent status()
Represents the conversion status of the `Asset`. Example: FINISHED.
-
relatedAssets
public On_EmbeddedContent relatedAssets(EmbeddedContent_relatedAssets callBuilder)
Paginated list of `Asset` items related to `Asset`.
-
comments
public On_EmbeddedContent comments(EmbeddedContent_comments callBuilder)
Paginated list of `AssetComment` items for `Asset`.
-
currentUserPermissions
public On_EmbeddedContent currentUserPermissions(EmbeddedContent_currentUserPermissions callBuilder)
Current `User` `Asset` permissions.
-
customMetadata
public On_EmbeddedContent customMetadata(EmbeddedContent_customMetadata callBuilder)
List of `CustomMetadataProperty` items and values associated to `Asset`.
-
workflowTask
public On_EmbeddedContent workflowTask(EmbeddedContent_workflowTask callBuilder)
**BETA** The `WorkflowTask` this `Asset` is linked to.
-
location
public On_EmbeddedContent location(EmbeddedContent_location callBuilder)
`Location` of the `Asset`.
-
previewBackgroundColor
public On_EmbeddedContent previewBackgroundColor(EmbeddedContent_previewBackgroundColor callBuilder)
**BETA** Background color of the `Asset` preview.
-
previewUrl
public On_EmbeddedContent previewUrl()
Preview of the embedded content. If the preview is not available, an svg icon will be returned.
-
thumbnailUrl
public On_EmbeddedContent thumbnailUrl()
Provides a `Url` for the custom user defined thumbnail or a system generated one when possible.
-
-