MessagingOptions interface

Interface que representa as opções que podem ser fornecidas ao enviar uma mensagem por meio das APIs legadas do FCM.

Consulte Build enviar solicitações para amostras de código e documentação detalhada.

Assinatura:

export interface MessagingOptions 

Propriedades

MessagingOptions.collapseKey

String que identifica um grupo de mensagens (por exemplo, "Atualizações Disponíveis") que pode ser recolhido, para que apenas a última mensagem seja enviada quando a entrega puder ser retomada. Isso é usado para evitar o envio de muitas mensagens iguais quando o dispositivo volta a ficar on-line ou fica ativo.

Não há garantia da ordem em que as mensagens são enviadas.

É permitido um máximo de quatro chaves de recolhimento diferentes a qualquer momento. Isso significa que o servidor FCM pode armazenar simultaneamente quatro mensagens diferentes de envio para sincronização por aplicativo cliente. Se você exceder esse número, não há garantia de quais quatro chaves de recolhimento o servidor FCM manterá.

**Valor padrão:** Nenhum

Assinatura:

collapseKey?: string;

MessagingOptions.contentAvailable

No iOS, use este campo para representar content-available na carga útil dos APNs. Quando uma notificação ou mensagem de dados é enviada e isso está definido como true , um aplicativo cliente inativo será ativado. No Android, as mensagens de dados ativam o aplicativo por padrão. No Chrome, esse sinalizador não é compatível no momento.

**Valor padrão:** false

Assinatura:

contentAvailable?: boolean;

MessagingOptions.dryRun

Se a mensagem deve ou não ser enviada. Quando definido como true , permite que os desenvolvedores testem uma solicitação sem realmente enviar uma mensagem. Quando definido como false , a mensagem será enviada.

**Valor padrão:** false

Assinatura:

dryRun?: boolean;

MessagingOptions.mutableContent

No iOS, use este campo para representar mutable-content na carga útil dos APNs. Quando uma notificação é enviada e isso está definido como true , o conteúdo da notificação pode ser modificado antes de ser exibido, usando uma extensão de aplicativo do Notification Service .

No Android e na Web, este parâmetro será ignorado.

**Valor padrão:** false

Assinatura:

mutableContent?: boolean;

MessagingOptions.priority

A prioridade da mensagem. Os valores válidos são "normal" e "high". No iOS, correspondem às prioridades 5 e 10 dos APNs .

Por padrão, as mensagens de notificação são enviadas com prioridade alta e as mensagens de dados são enviadas com prioridade normal. A prioridade normal otimiza o consumo de bateria do aplicativo cliente e deve ser usada a menos que seja necessária entrega imediata. Para mensagens com prioridade normal, o aplicativo pode receber a mensagem com atraso indeterminado.

Quando uma mensagem é enviada com alta prioridade, ela é enviada imediatamente e o aplicativo pode ativar um dispositivo em suspensão e abrir uma conexão de rede com seu servidor.

Para obter mais informações, consulte Definir a prioridade de uma mensagem .

**Valor padrão:** "high" para mensagens de notificação, "normal" para mensagens de dados

Assinatura:

priority?: string;

MessagingOptions.restrictedPackageName

O nome do pacote do aplicativo ao qual os tokens de registro devem corresponder para receber a mensagem.

**Valor padrão:** Nenhum

Assinatura:

restrictedPackageName?: string;

MessagingOptions.timeToLive

Por quanto tempo (em segundos) a mensagem deve ser mantida no armazenamento do FCM se o dispositivo estiver off-line. O tempo máximo de vida suportado é de quatro semanas e o valor padrão também é de quatro semanas. Para obter mais informações, consulte Configurando a vida útil de uma mensagem .

**Valor padrão:** 2419200 (representando quatro semanas, em segundos)

Assinatura:

timeToLive?: number;