URLRepresentableEntity

protocol · iOS 18.0+ · SDK 27.1

protocol URLRepresentableEntity : AppEntity, CustomURLRepresentationParameterConvertible

An interface you apply to an app entity type so the system can handle it like a universal link. If your app already supports universal links for content, use this protocol to express your app entity types as URLs. When your app entity supports this protocol, the system can use the provided URL to refer to the item. For example, when an ``OpenIntent`` type contains the entity, the system can open the item by sending the entity’s URL to your app’s URL handling code. Having a URL representation for your app entity also makes it easier to share the contents of that entity with Siri, Shortcuts, and other system features. > Important: This protocol requires your app to support universal links. You can’t use this protocol with a custom URL scheme or other approaches. For information about how to add support for universal links, see <doc://com.apple.documentation/documentation/Xcode/allowing-apps-and-websites-to-link-to-your-content>. Construct URLs using static text and the content of properties in your app entity. For information on how to create the URL representation, see ``EntityURLRepresentation``.

Members (1)

var urlRepresentation: URL? { get async }

All AppIntents types →