AndroidNotification interface

AndroidConfig에 포함할 수 있는 Android 관련 알림 옵션을 나타냅니다.

서명:

export interface AndroidNotification

속성

속성 유형 설명
본문 문자열 Android 알림의 본문입니다. 제공되는 경우 admin.messaging.Notification를 통해 설정된 본문을 재정의합니다.
bodyLocArgs 문자열[] bodyLocKey에서 형식 지정자 대신 사용될 리소스 키의 배열입니다.
bodyLocKey로 변경됩니다. 문자열 앱의 문자열 리소스에서 본문 텍스트를 현지화하는 데 사용할 본문 문자열의 키입니다.
channelId 문자열 Android 알림 채널 ID (Android O의 새로운 기능). 이 채널 ID가 있는 알림을 받으려면 앱에서 이 채널 ID로 채널을 만들어야 합니다. 요청에서 이 채널 ID를 보내지 않거나 제공된 채널 ID를 앱에서 아직 만들지 않은 경우 FCM은 앱 매니페스트에 지정된 채널 ID를 사용합니다.
클릭 작업 문자열 사용자의 알림 클릭과 관련된 작업입니다. 지정하면 사용자가 알림을 클릭할 때 일치하는 인텐트 필터가 있는 활동이 실행됩니다.
색상 문자열 #rrggbb 형식의 알림 아이콘 색상입니다.
defaultLightSettings 부울 true로 설정하면 Android 프레임워크의 기본 LED 조명 설정을 알림에 사용합니다. 기본값은 config.xml에 지정됩니다. default_light_settings이 true로 설정되고 light_settings도 설정되면 기본값 대신 사용자가 지정한 light_settings이 사용됩니다.
defaultSound 부울 true로 설정하면 Android 프레임워크의 기본 사운드를 알림에 사용합니다. 기본값은 config.xml에 지정됩니다.
defaultVibrateTimings 부울 true로 설정하면 Android 프레임워크의 기본 진동 패턴을 알림에 사용합니다. 기본값은 config.xml에 지정됩니다. default_vibrate_timings이 true로 설정되고 vibrate_timings도 설정되면 사용자가 지정한 vibrate_timings 대신 기본값이 사용됩니다.
eventTimestamp 날짜 절대적 시간 참조를 사용하여 사용자에게 이벤트에 대해 알리는 알림의 경우 알림에서 이벤트가 발생한 시간을 설정합니다. 패널의 알림이 이 시간순으로 정렬됩니다.
아이콘 문자열 Android 알림의 아이콘 리소스입니다.
이미지 URL 문자열 알림에 표시될 이미지의 URL입니다.
lightSettings LightSettings 기기에서 LED를 사용할 수 있는 경우 알림의 LED 깜박임 속도와 색상을 제어하는 설정입니다. 총 깜박임 시간은 OS에서 제어합니다.
localOnly 부울 이 알림이 현재 기기에만 관련이 있는지 여부를 설정합니다. 일부 알림은 원격 디스플레이를 위해 Wear OS 시계와 같은 다른 기기에 브리징될 수 있습니다. 이 힌트는 이 알림을 브리징하지 않도록 권장하도록 설정할 수 있습니다. Wear OS 가이드를 참고하세요.
notificationCount 숫자 이 알림이 나타내는 항목의 수를 설정합니다. 배지 설정을 지원하는 런처에 대해 배지 수로 표시될 수 있습니다. NotificationBadge를 참조하세요. 예를 들어 하나의 알림만 사용하여 여러 개의 새 메시지를 나타내지만 여기에 표시된 개수가 총 새 메시지 수를 나타내려는 경우 유용할 수 있습니다. 0이거나 지정되지 않은 경우 배지 설정을 지원하는 시스템은 기본값을 사용합니다. 즉, 새 알림이 도착할 때마다 길게 누르기 메뉴에 표시되는 숫자가 증가합니다.
우선순위 ('min' | 'low' | '기본값' | 'high' | 'max') 이 알림에 상대적인 우선순위를 설정합니다. 경우에 따라 우선순위가 낮은 알림은 사용자에게 표시되지 않을 수 있습니다. 이 우선순위는 AndroidMessagePriority와 다릅니다. 이 우선순위는 메시지가 전달된 후에 클라이언트에서 처리됩니다. 반면 AndroidMessagePriority는 메시지가 전송되는 시기를 제어하는 FCM 개념입니다.
소리 문자열 기기가 알림을 수신하면 재생할 사운드의 파일 이름입니다.
고정 부울 false로 설정하거나 설정하지 않으면 사용자가 패널에서 알림을 클릭할 때 알림이 자동으로 닫힙니다. true로 설정하면 사용자가 알림을 클릭해도 알림이 유지됩니다.
태그 문자열 알림 태그. 알림 창에서 기존 알림을 대체하는 데 사용되는 식별자입니다. 지정하지 않으면 각 요청이 새 알림을 만듭니다.
티커 문자열 '티커'를 설정합니다. 접근성 서비스로 전송됩니다 API 수준 21 (Lollipop) 이전에는 알림이 처음 도착할 때 상태 표시줄에 표시되는 텍스트를 설정합니다.
title 문자열 Android 알림의 제목입니다. 제공되는 경우 admin.messaging.Notification를 통해 설정된 제목을 재정의합니다.
titleLocArgs 문자열[] titleLocKey에서 형식 지정자 대신 사용될 리소스 키의 배열입니다.
titleLocKey입니다. 문자열 앱의 문자열 리소스에서 제목 텍스트를 현지화하는 데 사용할 제목 문자열의 키입니다.
vibrateTimingsMillis 숫자[] 사용할 진동 패턴을 설정합니다. 진동을 켜거나 끄려면 밀리초 배열을 전달합니다. 첫 번째 값은 진동을 켜기 전에 기다려야 하는 시간을 나타냅니다. 다음 값은 진동을 켜진 상태로 유지할 시간을 나타냅니다. 다음 값은 진동을 끄는 시간과 진동을 켤 때까지 번갈아 표시됩니다. vibrate_timings가 설정되고 default_vibrate_timings가 true로 설정되면 사용자가 지정한 vibrate_timings 대신 기본값이 사용됩니다.
가시성 ('private' | 'public' | 'secret') 알림의 공개 상태를 설정합니다. private, public 또는 secret여야 합니다. 지정하지 않으면 기본적으로 private입니다.

AndroidNotification.body

Android 알림의 본문입니다. 제공되는 경우 admin.messaging.Notification를 통해 설정된 본문을 재정의합니다.

서명:

body?: string;

AndroidNotification.bodyLocArgs

bodyLocKey에서 형식 지정자 대신 사용될 리소스 키의 배열입니다.

서명:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

앱의 문자열 리소스에서 본문 텍스트를 현지화하는 데 사용할 본문 문자열의 키입니다.

서명:

bodyLocKey?: string;

AndroidNotification.channelId

Android 알림 채널 ID (Android O의 새로운 기능). 이 채널 ID가 있는 알림을 받으려면 앱에서 이 채널 ID로 채널을 만들어야 합니다. 요청에서 이 채널 ID를 보내지 않거나 제공된 채널 ID를 앱에서 아직 만들지 않은 경우 FCM은 앱 매니페스트에 지정된 채널 ID를 사용합니다.

서명:

channelId?: string;

AndroidNotification.clickAction

사용자의 알림 클릭과 관련된 작업입니다. 지정하면 사용자가 알림을 클릭할 때 일치하는 인텐트 필터가 있는 활동이 실행됩니다.

서명:

clickAction?: string;

AndroidNotification.color(Android 알림 색상)

#rrggbb 형식의 알림 아이콘 색상입니다.

서명:

color?: string;

AndroidNotification.defaultLightSettings

true로 설정하면 알림에 Android 프레임워크의 기본 LED 조명 설정을 사용합니다. 기본값은 config.xml에 지정됩니다. default_light_settings이 true로 설정되고 light_settings도 설정되면 기본값 대신 사용자가 지정한 light_settings이 사용됩니다.

서명:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

true로 설정하면 Android 프레임워크의 기본 사운드를 알림에 사용합니다. 기본값은 config.xml에 지정됩니다.

서명:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

true로 설정하면 알림에 Android 프레임워크의 기본 진동 패턴을 사용합니다. 기본값은 config.xml에 지정됩니다. default_vibrate_timings이 true로 설정되고 vibrate_timings도 설정되면 사용자가 지정한 vibrate_timings 대신 기본값이 사용됩니다.

서명:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

절대적 시간 참조를 사용하여 사용자에게 이벤트에 대해 알리는 알림의 경우 알림에서 이벤트가 발생한 시간을 설정합니다. 패널의 알림이 이 시간순으로 정렬됩니다.

서명:

eventTimestamp?: Date;

Android 알림 아이콘

Android 알림의 아이콘 리소스입니다.

서명:

icon?: string;

AndroidNotification.imageUrl

알림에 표시될 이미지의 URL입니다.

서명:

imageUrl?: string;

AndroidNotification.lightSettings

기기에서 LED를 사용할 수 있는 경우 알림의 LED 깜박임 속도와 색상을 제어하는 설정입니다. 총 깜박임 시간은 OS에서 제어합니다.

서명:

lightSettings?: LightSettings;

AndroidNotification.localOnly

이 알림이 현재 기기에만 관련이 있는지 여부를 설정합니다. 일부 알림은 원격 디스플레이를 위해 Wear OS 시계와 같은 다른 기기에 브리징될 수 있습니다. 이 힌트는 이 알림을 브리징하지 않도록 권장하도록 설정할 수 있습니다. Wear OS 가이드를 참고하세요.

서명:

localOnly?: boolean;

AndroidNotification.notificationCount

이 알림이 나타내는 항목의 수를 설정합니다. 배지 설정을 지원하는 런처에 대해 배지 수로 표시될 수 있습니다. NotificationBadge를 참조하세요. 예를 들어 하나의 알림만 사용하여 여러 개의 새 메시지를 나타내지만 여기에 표시된 개수가 총 새 메시지 수를 나타내려는 경우 유용할 수 있습니다. 0이거나 지정되지 않은 경우 배지 설정을 지원하는 시스템은 기본값을 사용합니다. 즉, 새 알림이 도착할 때마다 길게 누르기 메뉴에 표시되는 숫자가 증가합니다.

서명:

notificationCount?: number;

AndroidNotification.우선순위

이 알림에 상대적인 우선순위를 설정합니다. 경우에 따라 우선순위가 낮은 알림은 사용자에게 표시되지 않을 수 있습니다. 이 우선순위는 AndroidMessagePriority와 다릅니다. 이 우선순위는 메시지가 전달된 후에 클라이언트에서 처리됩니다. 반면 AndroidMessagePriority는 메시지가 전송되는 시기를 제어하는 FCM 개념입니다.

서명:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.sound

기기가 알림을 수신하면 재생할 사운드의 파일 이름입니다.

서명:

sound?: string;

AndroidNotification.스틱

false로 설정하거나 설정하지 않으면 사용자가 패널에서 알림을 클릭할 때 알림이 자동으로 닫힙니다. true로 설정하면 사용자가 알림을 클릭해도 알림이 유지됩니다.

서명:

sticky?: boolean;

AndroidNotification.태그

알림 태그. 알림 창에서 기존 알림을 대체하는 데 사용되는 식별자입니다. 지정하지 않으면 각 요청이 새 알림을 만듭니다.

서명:

tag?: string;

AndroidNotification.ticker

'티커'를 설정합니다. 접근성 서비스로 전송됩니다 API 수준 21 (Lollipop) 이전에는 알림이 처음 도착할 때 상태 표시줄에 표시되는 텍스트를 설정합니다.

서명:

ticker?: string;

AndroidNotification.title

Android 알림의 제목입니다. 제공되는 경우 admin.messaging.Notification를 통해 설정된 제목을 재정의합니다.

서명:

title?: string;

AndroidNotification.titleLocArgs

titleLocKey에서 형식 지정자 대신 사용될 리소스 키의 배열입니다.

서명:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

앱의 문자열 리소스에서 제목 텍스트를 현지화하는 데 사용할 제목 문자열의 키입니다.

서명:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

사용할 진동 패턴을 설정합니다. 진동을 켜거나 끄려면 밀리초 배열을 전달합니다. 첫 번째 값은 진동을 켜기 전에 기다려야 하는 시간을 나타냅니다. 다음 값은 진동을 켜진 상태로 유지할 시간을 나타냅니다. 다음 값은 진동을 끄는 시간과 진동을 켤 때까지 번갈아 표시됩니다. vibrate_timings가 설정되고 default_vibrate_timings가 true로 설정되면 사용자가 지정한 vibrate_timings 대신 기본값이 사용됩니다.

서명:

vibrateTimingsMillis?: number[];

AndroidNotification.Visibility

알림의 공개 상태를 설정합니다. private, public 또는 secret이어야 합니다. 지정하지 않으면 기본값은 private입니다.

서명:

visibility?: ('private' | 'public' | 'secret');