For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal
Theme
Codex

Codex use case

Adicione App Intents ao seu aplicativo iOS

Use o Codex para disponibilizar as ações e o conteúdo do seu aplicativo no Atalhos, na Siri, no Spotlight e em recursos mais recentes do sistema que usam assistentes.

Difficulty Advanced
Time horizon 1h

Use o Codex e o plugin Build iOS Apps para identificar quais ações e entidades seu aplicativo deve disponibilizar por meio do framework App Intents. Integre essas ações e entidades a recursos do sistema, como o Atalhos e o Spotlight, e prepare o aplicativo para que assistentes possam executar mais fluxos de trabalho ao longo do tempo.

Best for

  • Aplicativos iOS que já oferecem ações ou conteúdo úteis, mas ainda não os disponibilizam no Atalhos, na Siri, no Spotlight ou em outros recursos do sistema
  • Equipes que querem disponibilizar algumas das ações mais úteis agora e, aos poucos, criar fluxos de trabalho mais fáceis de executar com assistentes
  • Aplicativos com objetos bem definidos, como contas, listas, filtros, destinos, rascunhos ou itens de mídia, que podem se tornar entidades acessíveis fora da interface do aplicativo

Contents

    ← All use cases

    Adicione App Intents ao seu aplicativo iOS

    Use o Codex para disponibilizar as ações e o conteúdo do seu aplicativo no Atalhos, na Siri, no Spotlight e em recursos mais recentes do sistema que usam assistentes.

    Use o Codex e o plugin Build iOS Apps para identificar quais ações e entidades seu aplicativo deve disponibilizar por meio do framework App Intents. Integre essas ações e entidades a recursos do sistema, como o Atalhos e o Spotlight, e prepare o aplicativo para que assistentes possam executar mais fluxos de trabalho ao longo do tempo.

    Advanced
    1h

    Use o Codex e o plugin Build iOS Apps para identificar quais ações e entidades seu aplicativo deve disponibilizar por meio do framework App Intents. Integre essas ações e entidades a recursos do sistema, como o Atalhos e o Spotlight, e prepare o aplicativo para que assistentes possam executar mais fluxos de trabalho ao longo do tempo.

    Advanced
    1h

    Best for

    • Aplicativos iOS que já oferecem ações ou conteúdo úteis, mas ainda não os disponibilizam no Atalhos, na Siri, no Spotlight ou em outros recursos do sistema
    • Equipes que querem disponibilizar algumas das ações mais úteis agora e, aos poucos, criar fluxos de trabalho mais fáceis de executar com assistentes
    • Aplicativos com objetos bem definidos, como contas, listas, filtros, destinos, rascunhos ou itens de mídia, que podem se tornar entidades acessíveis fora da interface do aplicativo

    Skills & Plugins

    • Use as Habilidades de compilação para iOS e de SwiftUI para adicionar App Intents, entidades do aplicativo e App Shortcuts. Depois, confirme que o aplicativo continua compilando e que cada intent leva ao ponto de entrada correto.
    Skill Why use it
    Build iOS Apps Use as Habilidades de compilação para iOS e de SwiftUI para adicionar App Intents, entidades do aplicativo e App Shortcuts. Depois, confirme que o aplicativo continua compilando e que cada intent leva ao ponto de entrada correto.

    Starter prompt

    Use o plugin Build iOS Apps para revisar este aplicativo iOS e adicionar App Intents para as ações e entidades que devem ficar disponíveis ao sistema. Restrições - Comece identificando as ações mais úteis para os usuários e os principais objetos do aplicativo que devem ficar disponíveis fora dele, no Atalhos, na Siri, no Spotlight, em widgets, em controles ou em recursos mais recentes do sistema que usam assistentes. - Limite o escopo da primeira etapa. Escolha poucos intents que sejam úteis mesmo sem abrir o aplicativo completo. Inclua também os intents que devem abrir o aplicativo diretamente em uma tela ou fluxo de trabalho específico. - Defina entidades do aplicativo apenas para os dados de que o sistema precisa para entender e encaminhar essas ações. Se um conjunto menor de entidades for suficiente, evite reproduzir toda a camada interna de modelos. - Adicione App Shortcuts quando eles facilitarem a descoberta das ações. Escolha títulos, frases e representações para exibição que façam sentido na Siri, no Spotlight e no Atalhos. - Se o aplicativo precisar tratar um intent na interface principal, encaminhe o resultado de volta ao aplicativo e explique como a cena do aplicativo responde ao recebê-lo. - Ao concluir a primeira etapa, compile e valide o aplicativo. Em seguida, resuma quais ações e entidades ele passou a oferecer e com quais recursos do sistema passou a se integrar. Entregue - o conjunto de intents e entidades que você recomenda disponibilizar na primeira versão - os intents, as entidades e os App Shortcuts implementados - uma descrição de como o aplicativo encaminha ou trata esses intents em tempo de execução - uma lista dos recursos do sistema da Apple que essa integração já permite usar e dos que fazem sentido para a próxima etapa
    Use o plugin Build iOS Apps para revisar este aplicativo iOS e adicionar App Intents para as ações e entidades que devem ficar disponíveis ao sistema. Restrições - Comece identificando as ações mais úteis para os usuários e os principais objetos do aplicativo que devem ficar disponíveis fora dele, no Atalhos, na Siri, no Spotlight, em widgets, em controles ou em recursos mais recentes do sistema que usam assistentes. - Limite o escopo da primeira etapa. Escolha poucos intents que sejam úteis mesmo sem abrir o aplicativo completo. Inclua também os intents que devem abrir o aplicativo diretamente em uma tela ou fluxo de trabalho específico. - Defina entidades do aplicativo apenas para os dados de que o sistema precisa para entender e encaminhar essas ações. Se um conjunto menor de entidades for suficiente, evite reproduzir toda a camada interna de modelos. - Adicione App Shortcuts quando eles facilitarem a descoberta das ações. Escolha títulos, frases e representações para exibição que façam sentido na Siri, no Spotlight e no Atalhos. - Se o aplicativo precisar tratar um intent na interface principal, encaminhe o resultado de volta ao aplicativo e explique como a cena do aplicativo responde ao recebê-lo. - Ao concluir a primeira etapa, compile e valide o aplicativo. Em seguida, resuma quais ações e entidades ele passou a oferecer e com quais recursos do sistema passou a se integrar. Entregue - o conjunto de intents e entidades que você recomenda disponibilizar na primeira versão - os intents, as entidades e os App Shortcuts implementados - uma descrição de como o aplicativo encaminha ou trata esses intents em tempo de execução - uma lista dos recursos do sistema da Apple que essa integração já permite usar e dos que fazem sentido para a próxima etapa

    Escolha quais partes do aplicativo disponibilizar ao sistema

    O framework App Intents oferece uma das maneiras mais diretas de tornar um aplicativo iOS mais útil fora da própria interface. Use o Codex para disponibilizar as ações e os objetos do aplicativo no Atalhos, na Siri, no Spotlight, em widgets, em controles e em recursos mais recentes do sistema que usam assistentes. Assim, quem usa o aplicativo pode acessar esses recursos sem precisar primeiro abri-lo e navegar pelas telas.

    Hoje, isso já facilita a descoberta de recursos e a automação de tarefas. Também prepara o aplicativo para um futuro em que os assistentes terão um papel maior. Se o aplicativo já permite criar, abrir, filtrar, encaminhar ou resumir algo de interesse para o usuário, o App Intents dá ao sistema uma forma estruturada de solicitar essa operação.

    Comece pelas ações e entidades que vale a pena expor

    Na primeira integração com o App Intents, raramente vale a pena “reproduzir todas as telas do aplicativo”. Peça ao Codex que identifique

    • as poucas ações que o usuário gostaria de executar sem percorrer toda a interface
    • os objetos do aplicativo que o sistema precisa reconhecer para encaminhar essas ações corretamente
    • quais fluxos devem abrir o aplicativo em um estado específico e quais devem ser concluídos diretamente pela interface do sistema

    A documentação da Apple sobre o App Intents sugere uma sequência para esse trabalho. Defina a ação, determine quais entidades o sistema precisa conhecer e disponibilize as ações para que possam ser encontradas e reutilizadas em diferentes recursos do sistema. As referências mais úteis são Como facilitar a descoberta de ações e conteúdo e ampliar sua disponibilidade, Como criar a primeira intenção do aplicativo e o exemplo Como integrar o App Intents aos recursos do sistema.

    Considere as interfaces do sistema além dos atalhos

    A integração vai além de “adicionar um atalho”. Ao escolher bem as ações e entidades que vai expor pelo App Intents, você pode tornar o aplicativo útil em vários contextos:

    • no Atalhos, onde os usuários podem executar ações diretamente ou combiná-las em automações maiores
    • na Siri, onde o aplicativo pode oferecer comandos para ações específicas e links diretos que levam o usuário além da tela inicial
    • no Spotlight, onde os usuários podem encontrar entidades e atalhos do aplicativo e acessá-los pelo sistema
    • em widgets, Atividades ao Vivo, controles e outras interfaces que usam intenções
    • em recursos mais recentes voltados a assistentes, nos quais o sistema consegue interpretar ações e entidades estruturadas com muito mais facilidade do que sequências arbitrárias de interação com a interface

    Adote uma estrutura que funcione na prática

    Em geral, a integração funciona melhor quando o aplicativo se organiza da seguinte forma:

    • um alvo de compilação dedicado ao App Intents para manter os tipos de intenção juntos, sem espalhá-los por arquivos do aplicativo que têm outras funções
    • entradas em AppShortcutsProvider para ações importantes para o usuário, como escrever uma publicação ou abrir o aplicativo em uma aba específica
    • tipos AppEntity pequenos para representar objetos que o sistema precisa interpretar, como contas, listas e filtros da linha do tempo
    • um mecanismo que encaminhe as intenções à cena principal do aplicativo, para que uma intenção, ao ser acionada, possa abrir o fluxo de criação adequado ou mudar para a aba correta

    Para a maioria dos aplicativos, eu pediria ao Codex que seguisse esse padrão. Comece com uma pequena camada de ações acessíveis ao sistema, limite as informações que as entidades expõem e defina como transferir o controle de volta ao aplicativo de forma previsível quando uma intenção precisar da interface principal durante a execução.

    Peça ao Codex que defina o conjunto inicial de intenções

    Para escrever um bom prompt, descreva os objetos centrais do aplicativo e as principais ações dos usuários. Em seguida, peça ao Codex que escolha o menor conjunto de ações e entidades que já seja útil expor pelo App Intents. Isso evita disponibilizar tudo sem critério.

    Dicas práticas

    Disponibilize ações que os usuários queiram executar fora do aplicativo

    Criar conteúdo, abrir, encontrar, filtrar, iniciar, continuar ou inspecionar algo costumam ser boas opções para as primeiras intenções. Se uma ação só for útil depois de uma configuração demorada no aplicativo, talvez seja melhor deixá-la para uma etapa posterior da integração com o App Intents.

    Exponha nas entidades apenas parte da camada de modelos

    Em geral, o sistema não precisa do modelo de persistência completo. Peça ao Codex que exponha apenas as informações das entidades do aplicativo de que a Siri, o Atalhos e o Spotlight precisam para encaminhar e exibir a ação corretamente.

    Use a integração como infraestrutura para assistentes, além de oferecer atalhos

    Mesmo que, na primeira versão, os usuários só percebam melhorias no Atalhos ou na Siri, o aplicativo passa a expressar seus recursos por meio de ações e entidades estruturadas. Isso facilita a integração com futuros pontos de acesso oferecidos pelo sistema ou por IA, em comparação com um aplicativo cujos recursos só estão representados em sequências de toques e hierarquias de visualizações.

    Tech stack

    Need

    Ações disponíveis ao sistema

    Default options

    App Intents

    Why it's needed

    O framework App Intents define o contrato que permite ao sistema apresentar as ações do aplicativo no Atalhos, na Siri, no Spotlight, em widgets, em controles e em interfaces mais recentes para assistentes.

    Need

    Dados do aplicativo disponíveis ao sistema

    Default options

    AppEntity, EntityQuery e representações para exibição

    Why it's needed

    Uma camada de entidades pequena e bem definida permite que o sistema entenda os objetos do aplicativo sem que você precise expor toda a camada de modelos.

    Need

    Descoberta de ações

    Default options

    AppShortcutsProvider com frases, títulos e símbolos claros

    Why it's needed

    Com os App Shortcuts, os usuários podem encontrar e executar as primeiras ações disponibilizadas com mais facilidade, sem precisar criar os atalhos do zero.

    Need

    Ciclo de validação

    Default options

    xcodebuild, testes no simulador e verificação do roteamento dos intents em tempo de execução

    Why it's needed

    Além de compilar o target de intents, o desafio é confirmar que, quando o sistema invoca um intent, o aplicativo abre na tela correta ou navega até ela.

    Need Default options Why it's needed
    Ações disponíveis ao sistema App Intents O framework App Intents define o contrato que permite ao sistema apresentar as ações do aplicativo no Atalhos, na Siri, no Spotlight, em widgets, em controles e em interfaces mais recentes para assistentes.
    Dados do aplicativo disponíveis ao sistema AppEntity , EntityQuery e representações para exibição Uma camada de entidades pequena e bem definida permite que o sistema entenda os objetos do aplicativo sem que você precise expor toda a camada de modelos.
    Descoberta de ações AppShortcutsProvider com frases, títulos e símbolos claros Com os App Shortcuts, os usuários podem encontrar e executar as primeiras ações disponibilizadas com mais facilidade, sem precisar criar os atalhos do zero.
    Ciclo de validação xcodebuild , testes no simulador e verificação do roteamento dos intents em tempo de execução Além de compilar o target de intents, o desafio é confirmar que, quando o sistema invoca um intent, o aplicativo abre na tela correta ou navega até ela.

    Related use cases