To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Matches an asset interaction against a request's "format" query parameter, used to serve alternate rendered formats of an asset such as a transcoded video or resized image. Configured on an AssetViewMapping as the matcher for a view: the view applies when the request's "format" parameter equals the name built from this matcher's FormatSpec, and the same name is used to build the href suffix for links to that view. Persisted to XML under the alias "alt-format-matcher".
Group: Content
Implements: AssetInteractionMatcher
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Short human-readable description of the format this matcher selects, used in admin listings. |
Methods
isMatched(Asset asset)
Returns: boolean
Checks whether the current request's "format" parameter matches the name built from this matcher's format spec.
| Parameter | Description |
|---|---|
asset | the asset the interaction applies to (not used by this matcher) |
getHrefSuffix(Asset asset)
Returns: String
Builds the "format=..." query string suffix that selects this format when appended to the asset's href.
| Parameter | Description |
|---|---|
asset | the asset the interaction applies to (not used by this matcher) |
getDescription()
Returns: String
Short human-readable description of the format this matcher selects, used in admin listings.
© 2025 Kademi Ltd