chrome.notifications

Descrição

Use a API chrome.notifications para criar notificações avançadas usando modelos e mostrar essas notificações aos usuários na bandeja do sistema.

Permissões

notifications

Tipos

NotificationBitmap

NotificationButton

Propriedades

  • iconUrl

    string opcional

    Suspensas desde o Chrome 59

    Ícones de botão não visíveis para usuários do Mac OS X.

  • título

    string

NotificationItem

Propriedades

  • mensagem

    string

    Outros detalhes sobre este item.

  • título

    string

    Título de um item de uma notificação de lista.

NotificationOptions

Propriedades

  • appIconMaskUrl

    string opcional

    Suspensas desde o Chrome 59

    A máscara do ícone do app não fica visível para usuários do Mac OS X.

    Um URL para a máscara do ícone do app. Os URLs têm as mesmas restrições que iconUrl.

    A máscara do ícone do app precisa estar no canal alfa, já que apenas esse canal da imagem será considerado.

  • botões

    NotificationButton[] opcional

    Texto e ícones para até dois botões de ação de notificação.

  • contextMessage

    string opcional

    Alterne o conteúdo da notificação com uma fonte de peso menor.

  • eventTime

    number optional

    Um carimbo de data/hora associado à notificação, em milissegundos após o período (por exemplo, Date.now() + n).

  • iconUrl

    string opcional

    Um URL para o avatar do remetente, o ícone do app ou uma miniatura para notificações de imagem.

    Os URLs podem ser de dados, de blob ou relativos a um recurso no arquivo .crx da extensão.

    **Observação**: esse valor é obrigatório para o método notifications.create().

  • imageUrl

    string opcional

    Suspensas desde o Chrome 59

    A imagem não fica visível para usuários do Mac OS X.

    Um URL para a miniatura da imagem em notificações do tipo imagem. Os URLs têm as mesmas restrições que iconUrl.

  • isClickable

    booleano opcional

    Suspenso desde o Chrome 67

    Essa dica de interface é ignorada a partir do Chrome 67.

  • itens

    NotificationItem[] opcional

    Itens para notificações de vários itens. Os usuários do Mac OS X só veem o primeiro item.

  • mensagem

    string opcional

    Conteúdo principal da notificação.

    **Observação**: esse valor é obrigatório para o método notifications.create().

  • prioridade

    number optional

    A prioridade varia de -2 a 2. -2 é a prioridade mais baixa. 2 é o mais alto. O padrão é zero. Em plataformas que não têm uma central de notificações (Windows, Linux e Mac), -2 e -1 resultam em um erro porque as notificações com essas prioridades não são mostradas.

  • progresso

    number optional

    O progresso atual varia de 0 a 100.

  • requireInteraction

    booleano opcional

    Chrome 50 ou mais recente

    Indica que a notificação deve permanecer visível na tela até que o usuário a ative ou dispense. O padrão é "false".

  • silencioso

    booleano opcional

    Chrome 70 ou mais recente

    Indica que nenhum som ou vibração deve ser emitido quando a notificação é mostrada. O padrão é "false".

  • título

    string opcional

    Título da notificação (por exemplo, nome do remetente do e-mail).

    **Observação**: esse valor é obrigatório para o método notifications.create().

  • tipo

    TemplateType opcional

    Qual tipo de notificação mostrar. Obrigatório para o método notifications.create.

PermissionLevel

Enumeração

"granted"
Especifica que o usuário escolheu mostrar notificações do app ou da extensão. Essa é a configuração padrão no momento da instalação.

"denied"
Especifica que o usuário optou por não mostrar notificações do app ou da extensão.

TemplateType

Enumeração

"basic"
Contém um ícone, um título, uma mensagem, uma mensagem expandida e até dois botões.

"image"
Contém um ícone, um título, uma mensagem, uma expandedMessage, uma imagem e até dois botões.

"list"
Contém um ícone, título, mensagem, itens e até dois botões. Os usuários do Mac OS X só veem o primeiro item.

"progress"
Contém um ícone, título, mensagem, progresso e até dois botões.

Métodos

clear()

Promise 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
): Promise<boolean>

Limpa a notificação especificada.

Parâmetros

  • notificationId

    string

    O ID da notificação a ser removida. Isso é retornado pelo método notifications.create.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (wasCleared: boolean) => void

    • wasCleared

      booleano

Retorna

  • Promise<boolean>

    Chrome 116 ou mais recente

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

create()

Promise 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
): Promise<string>

Cria e mostra uma notificação.

Parâmetros

  • notificationId

    string opcional

    Identificador da notificação. Se não estiver definido ou vazio, um ID será gerado automaticamente. Se ela corresponder a uma notificação existente, esse método primeiro vai limpar essa notificação antes de prosseguir com a operação de criação. O identificador não pode ter mais de 500 caracteres.

    O parâmetro notificationId é obrigatório antes do Chrome 42.

  • Conteúdo da notificação.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (notificationId: string) => void

    • notificationId

      string

Retorna

  • Promise<string>

    Chrome 116 ou mais recente

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getAll()

Promise 
chrome.notifications.getAll(
  callback?: function,
): Promise<object>

Recupera todas as notificações do app ou da extensão.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (notifications: object) => void

    • notificações

      objeto

Retorna

  • Promise<object>

    Chrome 116 ou mais recente

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getPermissionLevel()

Promise 
chrome.notifications.getPermissionLevel(
  callback?: function,
): Promise<PermissionLevel>

Recupera se o usuário ativou as notificações desse app ou extensão.

Parâmetros

Retorna

  • Promise<PermissionLevel>

    Chrome 116 ou mais recente

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

update()

Promise 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
): Promise<boolean>

Atualiza uma notificação existente.

Parâmetros

  • notificationId

    string

    O ID da notificação a ser atualizada. Isso é retornado pelo método notifications.create.

  • Conteúdo da notificação a ser atualizada.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (wasUpdated: boolean) => void

    • wasUpdated

      booleano

Retorna

  • Promise<boolean>

    Chrome 116 ou mais recente

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onButtonClicked

chrome.notifications.onButtonClicked.addListener(
  callback: function,
)

O usuário pressionou um botão na notificação.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (notificationId: string, buttonIndex: number) => void

    • notificationId

      string

    • buttonIndex

      número

onClicked

chrome.notifications.onClicked.addListener(
  callback: function,
)

O usuário clicou em uma área da notificação que não era um botão.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (notificationId: string) => void

    • notificationId

      string

onClosed

chrome.notifications.onClosed.addListener(
  callback: function,
)

A notificação foi fechada pelo sistema ou por uma ação do usuário.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (notificationId: string, byUser: boolean) => void

    • notificationId

      string

    • byUser

      booleano

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

O usuário muda o nível de permissão. A partir do Chrome 47, apenas o ChromeOS tem uma interface que envia esse evento.

Parâmetros

onShowSettings

Suspensas desde o Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

O botão de configurações de notificação personalizadas não está mais disponível.

O usuário clicou em um link para as configurações de notificação do app. A partir do Chrome 47, apenas o ChromeOS tem uma interface que envia esse evento. No Chrome 65, essa interface também foi removida do ChromeOS.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    () => void