Feed padrão do InboxKit com cartões de banner, com legenda, clássico, carrossel, vídeo e Apple Wallet.

for an

. */}

Cartão de banner do InboxKit — **Cartão de banner**

Cartão com legenda do InboxKit — **Cartão com legenda**

Cartão clássico do InboxKit — **Cartão clássico**

Cartão de carrossel do InboxKit — **Cartão de carrossel**

Cartão de vídeo do InboxKit — **Cartão de vídeo**

Cartão Apple Wallet do InboxKit — **Cartão Apple Wallet**

Os cartões de banner, com legenda e clássicos são controlados pelos campos de mensagem padrão (imagem, título, corpo) mais o array opcional `buttons` — veja [Adicionar botões de CTA em linha](#adicionar-botoes-de-cta-em-linha). Os cartões de carrossel, vídeo e Apple Wallet carregam dados estruturados extras dentro de `data`, documentados abaixo. ### Cartão de carrossel Um carrossel renderiza várias imagens de uma única mensagem — uma galeria deslizável com legendas por slide e destinos de toque opcionais. Os slides ficam em `data.carousel`. Cada slide precisa de uma `image`; `title` (sobreposição de legenda) e `url` (deep link aberto ao tocar) são opcionais. Um slide sem imagem é descartado; um toque em um slide sem `url` recai para a ação de linha padrão da mensagem. ```json title="POST https://api.pushwoosh.com/json/1.3/createMessage" { "request": { "application": "XXXXX-XXXXX", "auth": "API_TOKEN", "notifications": [{ "send_date": "now", "ios_title": "New arrivals", "content": "Swipe through this week's drops", "inbox_days": 7, "data": { "displayType": "carousel", "carousel": [ { "image": "https://cdn.example.com/inbox/1.jpg", "title": "New in", "url": "myapp://product/1" }, { "image": "https://cdn.example.com/inbox/2.jpg", "title": "On sale", "url": "myapp://product/2" }, { "image": "https://cdn.example.com/inbox/3.jpg" } ] }, "platforms": [1] }] } } ``` ### Cartão de vídeo Um cartão de vídeo mostra uma imagem de pôster com um ícone de play; tocá-lo abre um player em tela cheia (com som, mesmo com o interruptor de silêncio ativado). O descritor fica em `data.video`: `url` é obrigatório e deve ser um stream ou arquivo `http`/`https`; `poster` é uma imagem de pré-visualização opcional. ```json title="POST https://api.pushwoosh.com/json/1.3/createMessage" { "request": { "application": "XXXXX-XXXXX", "auth": "API_TOKEN", "notifications": [{ "send_date": "now", "ios_title": "Watch the reveal", "content": "Tap to play", "inbox_days": 7, "data": { "displayType": "video", "video": { "url": "https://cdn.example.com/inbox/clip.mp4", "poster": "https://cdn.example.com/inbox/poster.jpg" } }, "platforms": [1] }] } } ``` ### Cartão Apple Wallet O cartão Apple Wallet mostra uma imagem de herói opcional, título e corpo acima do botão oficial **Adicionar à Carteira da Apple**. Tocar no botão baixa o `.pkpass` e apresenta a folha do sistema para adicionar passes. Use-o para entregar cupons, cartões de fidelidade, ingressos ou cartões de embarque diretamente da caixa de entrada. O cartão é exclusivo para iOS / Mac Catalyst — em outras plataformas, a mensagem é renderizada como um cartão clássico. A URL do passe fica em `data.wallet`, seja como uma string simples ou como um objeto com um campo `pass`. Um `data.image` opcional adiciona a imagem de herói. O botão se esconde automaticamente quando não há URL de passe ou o dispositivo não pode adicionar passes. ```json title="POST https://api.pushwoosh.com/json/1.3/createMessage" { "request": { "application": "XXXXX-XXXXX", "auth": "API_TOKEN", "notifications": [{ "send_date": "now", "ios_title": "Your loyalty card is ready", "content": "Add it to Apple Wallet in one tap", "inbox_days": 7, "data": { "displayType": "wallet", "image": "https://cdn.example.com/inbox/loyalty.png", "wallet": "https://passes.example.com/v1/passes/pass.com.example.loyalty/abc123?token=…" }, "platforms": [1] }] } } ``` O resultado é reportado ao seu delegate: ```swift extension MyInboxHost: PushwooshInboxKitDelegate { func inboxKit(_ vc: PushwooshInboxKitViewController, didAddWalletPassFor message: PWInboxMessageProtocol) { // O passe agora está na Carteira do usuário — mostre uma confirmação se desejar. } func inboxKit(_ vc: PushwooshInboxKitViewController, didFailToAddWalletPassFor message: PWInboxMessageProtocol, error: Error?) { // O download falhou — exiba uma nova tentativa, registre em log, etc. } } ``` Ambos os callbacks são opcionais (eles carregam implementações vazias padrão). Um usuário cancelando a folha do sistema não é nem sucesso nem falha, então nenhum callback é disparado nesse caso. ## Acessibilidade As células do InboxKit estão prontas para o VoiceOver desde o início. Os cartões de banner, com legenda e clássicos expõem seu título, corpo e data através dos rótulos subjacentes, e os botões de CTA em linha leem seus próprios títulos. Os cartões ricos adicionam semântica explícita: - **Vídeo** — o pôster é exposto como um único elemento de botão rotulado "Reproduzir vídeo" (atributos `.button` + `.startsMediaSession`), então o VoiceOver o anuncia como um controle de mídia em vez de uma imagem simples. - **Carrossel** — cada slide é um elemento de botão cujo rótulo de acessibilidade é a legenda do slide, ou "Slide" quando não tem nenhuma. O indicador de página anuncia a posição atual como "*n* de *total*". - **Apple Wallet** — o botão **Adicionar à Carteira da Apple** é o `PKAddPassButton` padrão da Apple, que carrega seu próprio rótulo de VoiceOver localizado. Para testes de UI e automação, dois `accessibilityIdentifier`s estáveis são definidos: `inboxkit.video.play` no pôster do vídeo e `inboxkit.wallet.add` no botão da Carteira. ## Ler dados personalizados de uma mensagem Para fazer um push aparecer na caixa de entrada, a solicitação `createMessage` da [API de Mensagens](/pt/developer/api-reference/messages-api/) deve incluir `inbox_image`, `inbox_date` ou `inbox_days` — sem um desses campos, o push é entregue como uma notificação regular e nunca chega ao feed da caixa de entrada. Dados personalizados de formato livre vão sob a chave `data`, que o SDK entrega ao cliente como o parâmetro `u`: ```json title="POST https://api.pushwoosh.com/json/1.3/createMessage" { "request": { "application": "XXXXX-XXXXX", "auth": "API_TOKEN", "notifications": [{ "send_date": "now", "ios_title": "Summer sale", "content": "30% off everything — limited time only", "inbox_image": "https://cdn.example.com/inbox/summer.png", "inbox_days": 7, "data": { "displayType": "captioned", "promo_id": "SUMMER2026", "screen": "promo_details" }, "platforms": [1] }] } } ``` O SDK expõe esse objeto na mensagem da caixa de entrada através de `actionParams`. Leia-o do delegate quando o usuário tocar na linha ou em um CTA em linha: ```swift extension MyInboxHost: PushwooshInboxKitDelegate { func inboxKit(_ vc: PushwooshInboxKitViewController, didSelect message: PWInboxMessageProtocol) -> Bool { guard let params = message.actionParams as? [String: Any] else { return true } // O objeto `data` personalizado chega sob a chave "u" — // seja como um dicionário aninhado ou como uma string codificada em JSON, // dependendo de como o payload foi construído anteriormente. let custom: [String: Any]? = { if let dict = params["u"] as? [String: Any] { return dict } if let raw = params["u"] as? String, let bytes = raw.data(using: .utf8), let parsed = try? JSONSerialization.jsonObject(with: bytes) as? [String: Any] { return parsed } return nil }() if let promoId = custom?["promo_id"] as? String { navigateToPromo(promoId) return false // nós lidamos com o toque; o SDK não deve executar a ação padrão } return true } } ``` A mesma busca `actionParams["u"]` funciona dentro de `inboxKit(_:didTapButton:onMessage:)` para botões de CTA em linha. Para os casos de CTA tipados (`openURL`, `dismiss`, `markRead`), o SDK já executa a ação padrão — retorne `true` para manter esse comportamento, ou `false` para suprimi-lo e executar o seu próprio. ## Adicionar botões de CTA em linha Uma mensagem pode carregar até três botões de chamada para ação (CTA) em linha. Os botões ficam ao lado de outros dados personalizados dentro de `data` como um array `buttons`. O SDK os renderiza automaticamente dentro das células com legenda e clássicas: ```json title="POST https://api.pushwoosh.com/json/1.3/createMessage" { "request": { "application": "XXXXX-XXXXX", "auth": "API_TOKEN", "notifications": [{ "send_date": "now", "ios_title": "New promo card", "content": "Tap a button to claim or save", "inbox_image": "https://cdn.example.com/inbox/promo.png", "inbox_days": 7, "data": { "displayType": "captioned", "promo_id": "SUMMER2026", "buttons": [ { "title": "Claim", "url": "https://example.com/promo/SUMMER2026" }, { "title": "Read", "action": "markRead" }, { "title": "Save", "action": "custom", "tag": "save_promo" } ] }, "platforms": [1] }] } } ``` Cada objeto de botão tem estes campos: | Campo | Tipo | Quando | |---|---|---| | `title` | string | Obrigatório. Rótulo visível do botão. | | `url` | string | Uma URL analisável e não vazia produz uma ação `openURL`. O SDK a abre via `UIApplication.shared.open`, a menos que seu delegate a suprima. | | `action` | string | Token de ação explícito: `dismiss` (remove a mensagem do feed), `markRead` (marca a mensagem como lida) ou `custom` (tratado pelo host). Não diferencia maiúsculas de minúsculas. | | Qualquer outra coisa | any | Quando `action` é `custom`, todas as chaves no objeto do botão, exceto `title` e `action`, são encaminhadas para o seu delegate como o payload personalizado — combine uma chave com o profissional de marketing (por exemplo, `tag`) e despache com base nela. | Prioridade de resolução: primeiro o token `action` explícito, depois `url` se não estiver vazio, caso contrário, o botão cai em `custom` carregando o payload completo (menos `title` e `action`). Intercepte os toques do seu delegate. A propriedade `button.action` é o enum tipado `PushwooshInboxButtonAction`: ```swift extension MyInboxHost: PushwooshInboxKitDelegate { func inboxKit(_ vc: PushwooshInboxKitViewController, didTapButton button: PushwooshInboxButton, onMessage message: PWInboxMessageProtocol) -> Bool { switch button.action { case .openURL(let url): // O comportamento padrão está bom — deixe o SDK abrir a URL. return true case .dismiss, .markRead: // O SDK lida com ambos. Retorne false se quiser substituir. return true case .custom(let payload): // Botão personalizado definido pelo profissional de marketing. Despache com base em uma chave que vocês combinaram. if let tag = payload["tag"] as? String { switch tag { case "save_promo": saveCurrentPromoLocally(message: message) default: break } } return true // ignorado para custom — o SDK nunca executa uma ação padrão aqui } } } ```