GetEmbedExternalViewResponse

data class GetEmbedExternalViewResponse(val view: ExternalView? = null, val associatedRefs: List<StrongRef>? = null, val associatedRecords: List<JsonContent>? = null)

Parameters

view

Hydrated view of the embed. Present only when the resolved records back the requested URL and supply enough information to populate the required viewExternal fields. Omitted alongside the rest of the response when no records resolved or validation failed.

associatedRecords

The raw record data of the Atmosphere records that backed this view. This is returned for convenience, to avoid the need for the client to separately fetch the record data for the associatedRefs. Example: the site.standard.document and site.standard.publication records that backed this view.

Constructors

Link copied to clipboard
constructor(view: ExternalView? = null, associatedRefs: List<StrongRef>? = null, associatedRecords: List<JsonContent>? = null)

Properties

Link copied to clipboard

The raw record data of the Atmosphere records that backed this view. This is returned for convenience, to avoid the need for the client to separately fetch the record data for the associatedRefs. Example: the site.standard.document and site.standard.publication records that backed this view.

Link copied to clipboard
Link copied to clipboard

Hydrated view of the embed. Present only when the resolved records back the requested URL and supply enough information to populate the required viewExternal fields. Omitted alongside the rest of the response when no records resolved or validation failed.