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
Descontinuado desde o Chrome 59Os ícones de botão não são visíveis para usuários do Mac OS X.
-
title
string
NotificationItem
Propriedades
-
mensagem
string
São detalhes adicionais sobre este item.
-
title
string
Título de um item de uma notificação de lista.
NotificationOptions
Propriedades
-
appIconMaskUrl
string opcional
Descontinuado desde o Chrome 59A máscara do ícone do aplicativo não é 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 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
Alterne o conteúdo de notificação com uma fonte mais baixa.
-
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, o í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
Descontinuado desde o Chrome 59A imagem não é visível para usuários do Mac OS X.
Um URL para a miniatura da imagem para notificações do tipo de imagem. Os URLs têm as mesmas restrições que iconUrl.
-
isClickable
booleano opcional
Descontinuado desde o Chrome 67Essa dica de interface é ignorada a partir do Chrome 67
-
items
NotificationItem[] opcional
Itens para notificações com 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
()
. -
campanha
número opcional
A prioridade varia de -2 a 2. -2 é a prioridade mais baixa. 2 é o mais alto. Zero é o padrão. Em plataformas que não são compatíveis com 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 mais recenteIndica 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 recenteIndica que nenhum som ou vibração deve ser emitido quando a notificação está sendo exibida. O padrão é "false".
-
title
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 que será exibida. Obrigatório para o método
notifications.create
.
PermissionLevel
Tipo enumerado
"granted"
Especifica que o usuário optou por mostrar notificações do aplicativo ou 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
Tipo enumerado
"basic"
Contém um ícone, título, mensagem,expanddaMessage e até dois botões.
"image"
Contém um ícone, título, mensagem, expandMessage, 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()
chrome.notifications.clear(
notificationId: string,
callback?: function,
)
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 optional
O parâmetro
callback
tem esta aparência:(wasCleared: boolean) => void
-
wasCleared
boolean
-
Retorna
-
Promise<boolean>
Chrome 116 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
create()
chrome.notifications.create(
notificationId?: string,
options: NotificationOptions,
callback?: function,
)
Cria e mostra uma notificação.
Parâmetros
-
notificationId
string opcional
Identificador da notificação. Se a política não for definida ou estiver vazia, um ID será gerado automaticamente. Se corresponder a uma notificação existente, esse método primeiro apaga 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. -
do modelo.
Conteúdo da notificação.
-
callback
função optional
O parâmetro
callback
tem esta aparência:(notificationId: string) => void
-
notificationId
string
-
Retorna
-
Promessa<string>
Chrome 116 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
getAll()
chrome.notifications.getAll(
callback?: function,
)
Recupera todas as notificações desse app ou extensão.
Parâmetros
-
callback
função optional
O parâmetro
callback
tem esta aparência:(notifications: object) => void
-
notificações
objeto
-
Retorna
-
Promise<object>
Chrome 116 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
getPermissionLevel()
chrome.notifications.getPermissionLevel(
callback?: function,
)
Recupera se o usuário ativou as notificações desse aplicativo ou extensão.
Parâmetros
-
callback
função optional
O parâmetro
callback
tem esta aparência:(level: PermissionLevel) => void
-
level
-
Retorna
-
Promise<PermissionLevel>
Chrome 116 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
update()
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. Isso é retornado pelo método
notifications.create
. -
do modelo.
Conteúdo da notificação que será atualizada.
-
callback
função optional
O parâmetro
callback
tem esta aparência:(wasUpdated: boolean) => void
-
wasUpdated
boolean
-
Retorna
-
Promise<boolean>
Chrome 116 ou mais recentePromessas são compatíveis apenas 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
number
-
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 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
boolean
-
onPermissionLevelChanged
chrome.notifications.onPermissionLevelChanged.addListener(
callback: function,
)
O usuário altera o nível de permissão. A partir do Chrome 47, apenas o ChromeOS tem uma interface que envia esse evento.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(level: PermissionLevel) => void
-
level
-
onShowSettings
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. A partir do Chrome 65, essa interface também foi removida do ChromeOS.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:() => void