Manifest [offers] Section

[offers]

[[offers.service]]
# Configuration for offered services

[[offers.module]]
# Defining shared artifacts

[[offers.message-target]]
# Mapping URIs to lifecycle components

[[offers.interaction]]
# Configuration for allowed interactions

​

[[offers.service]]

• The services provided by this package
• The permissions that other installed apps need to use these services
  [[offers.service]]
  id = "com.foo.bar.service"
  

​

Fields

• id (string, required): The unique identifier of the service component. The identifier belongs to one of the components declared in the manifest under the [components] section.
• required-privileges (array of strings, optional): A list of privileges required to invoke the service. Only system packages can restrict access using required privileges. This restriction feature does not work for non-system packages.
  required-privileges = [
      "com.amazon.smart_app.privilege.access"
  ]
  

​

Examples

​

[[offers.module]]

[[offers.module]]
id = "/com.amazon.samplepkg.module@IMod1"

includes-messages = [
    "pkg://com.amazon.samplepkg.main",
    "samplepkg://play"
]

​

Fields

• id [string] (required): The fully-qualified identifier of the module must follow this format: . Replace and with the following information:
  • :
    • Must use reverse-DNS notation (such as com.company.product).
    • The parts of the reverse DNS name should be lowercase alphanumeric ASCII characters (a-z0-9) and underscores (_) only, with namespace parts separated by a dot (.). Words in namespace parts are separated with an underscore (_).
    • These constraints are described by the regular expression ^[a-z_][a-z0-9_]*(?:\.[a-z_][a-z0-9_]*)*$.
    • Must be unique in the system.
    • Tip: Using package ID as prefix helps ensure uniqueness.
  • @: Separator between component name and revision tag.
  • :
    • Follow the same naming convention as interfaces in IDL.
    • Must start with uppercase ‘I’, as is traditional in IDL languages of this sort: IThingDoer, not ThingDoer.
    • The character after ‘I’ must be uppercase.
    • Remaining characters can be alphanumeric (a-zA-Z0-9) or underscore (_).
    • These constraints are described by the regular expression ^I([A-Z][a-zA-Z0-9_]*)$.
      id = "/com.amazon.samplepkg.module@IMod1"
      
• includes-messages [array of strings] (optional): List of URIs defined by this module. Each URI must have a corresponding [[message]] section describing the sender and receiver privileges. Each URI can only be included in one module.
  includes-messages = [
      "pkg://com.amazon.samplepkg.main",
      "samplepkg://play"
  ]
  

​

Examples

​

[[offers.message-target]]

​

Fields

• uris [array of strings] (required): List of URIs that are part of the current mapping group.
  uris = [
    "samplepkg://play"
  ]
  
• uses-component [string] (required): Name of the component that is the recipient of the URI. The name should match a component listed in either the [components.interactive], or the [components.service], or the [components.task] sections in the manifest.
  uses-component = "com.amazon.samplepkg.main"
  

​

Examples

​

[[offers.interaction]]

[[offers.interaction]]
id = "com.foo.bar.interactive"
launch-uris = ["foo://interactive"]

​

Fields

• id (string, required): The unique identifier of the interactive or task component. The identifier belongs to one of the components declared in the manifest under the [components] section.
• launch-uris (array of strings, optional): A list of URIs that can be used to invoke the component.
  launch-uris = ["smart_app://main"]
  
• required-privileges (array of strings, optional): A list of privileges required to launch the component. Only system packages can restrict access using required privileges. This restriction feature does not work for non-system packages.
  required-privileges = [
      "com.amazon.smart_app.privilege.access"
  ]
  

​

Examples