chrome.notifications

Descrição

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

Permissões

notifications

Tipos

NotificationBitmap

NotificationButton

Propriedades

  • iconUrl

    string opcional

    Suspenso desde o Chrome 59

    Os ícones de botão não são visíveis aos usuários do Mac OS X.

  • título

    string

NotificationItem

Propriedades

  • mensagem

    string

    Mais detalhes sobre este item.

  • título

    string

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

NotificationOptions

Propriedades

  • appIconMaskUrl

    string opcional

    Suspenso desde o Chrome 59

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

    Um URL para a máscara de í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 o canal alfa 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

    Conteúdo de notificação alternativo com uma fonte menor.

  • eventTime

    número opcional

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

  • iconUrl

    string opcional

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

    Os URLs podem ser um URL de dados, um URL de blob ou um URL relativo a um recurso no arquivo .crx dessa extensão

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

  • imageUrl

    string opcional

    Suspenso desde o Chrome 59

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

    Um URL para a miniatura de imagem para 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 veem apenas 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

    número opcional

    Varia de prioridade de -2 a 2. -2 é a prioridade mais baixa. 2 é o mais alto. O padrão é zero. Em plataformas que não oferecem suporte a uma central de notificações (Windows, Linux e Mac), -2 e -1 resultam em um erro, já que as notificações com essas prioridades não serão exibidas.

  • progresso

    número opcional

    O progresso atual varia de 0 a 100.

  • requireInteraction

    booleano opcional

    Chrome 50 ou superior

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

  • silencioso

    booleano opcional

    Chrome 70 ou superior

    Indica que nenhum som ou vibração deve ser emitido quando a notificação estiver sendo exibida. 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

    O tipo de notificação a ser exibida. Obrigatório para o método notifications.create.

PermissionLevel

Enumeração

"granted"
Especifica que o usuário optou por mostrar notificações do aplicativo ou da extensão. Esse é 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, título, mensagem, expansívelMessage e até dois botões.

"image"
Contém um ícone, título, mensagem, expansívelMessage, 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()

Promessa 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

Limpa a notificação especificada.

Parâmetros

  • notificationId

    string

    O ID da notificação a ser apagada. Ela é retornada 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 versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

create()

Promessa 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

Cria e exibe uma notificação.

Parâmetros

  • notificationId

    string opcional

    Identificador da notificação. Se ela não for definida ou estiver vazia, um ID será gerado automaticamente. Se ele corresponder a uma notificação já existente, esse método 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

  • Promessa<string>

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

getAll()

Promessa 
chrome.notifications.getAll(
  callback?: function,
)

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

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (notifications: object) => void

    • notificações

      objeto

Retorna

  • Promise&lt;object&gt;

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

getPermissionLevel()

Promessa 
chrome.notifications.getPermissionLevel(
  callback?: function,
)

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

Parâmetros

Retorna

  • Promise&lt;PermissionLevel&gt;

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

update()

Promessa 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

Atualiza uma notificação existente.

Parâmetros

  • notificationId

    string

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

  • Conteúdo da notificação de atualização.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (wasUpdated: boolean) => void

    • wasUpdated

      booleano

Retorna

  • Promise&lt;boolean&gt;

    Chrome 116 ou versões mais recentes

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

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

      number

onClicked

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

O usuário clicou em uma área sem botão da notificaçã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, seja pelo sistema ou por 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

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

O botão de configurações de notificação personalizadas não é mais compatí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