푸시 API

선언적 푸시 메시지는 다음 멤버를 가집니다:

web_push (필수)

반드시 8030이어야 하는 정수입니다. 선언적 푸시 메시지와 다른 JSON 문서를 구분하는 데 사용됩니다.

notification (필수)

다음과 같은 멤버로 구성된 JSON 객체로, 모두 Notifications API 기능과 유사하지만, 경우에 따라 타입이 더 엄격할 수 있습니다. title을 제외한 모든 멤버는 NotificationOptions 딕셔너리에서 파생되며, 함께 관리되어야 합니다. [NOTIFICATIONS]

title (필수)

문자열입니다.

dir

"auto", "ltr", 또는 "rtl".

lang

언어 태그를 담는 문자열입니다.

body

문자열입니다.

navigate (필수)

URL을 담는 문자열입니다.

tag

문자열입니다.

image

URL을 담는 문자열입니다.

icon

URL을 담는 문자열입니다.

badge

URL을 담는 문자열입니다.

vibrate

32비트 부호 없는 정수의 배열입니다.

timestamp

64비트 부호 없는 정수입니다.

renotify

불리언 값입니다.

silent

불리언 값입니다.

requireInteraction

불리언 값입니다.

참고

NotificationOptions 딕셔너리와의 일관성을 위해 require_interaction이 아닌 이름을 사용합니다.

data

모든 JSON 값.

actions

다음 멤버로 구성된 JSON 객체 배열로, 모두 NotificationAction 딕셔너리에서 파생되며, 함께 관리되어야 합니다.

action (필수)

문자열입니다.

title (필수)

문자열입니다.

navigate (필수)

URL을 담는 문자열입니다.

icon

URL을 담는 문자열입니다.

mutable

불리언 값입니다. true일 경우 Notification 객체가 포함된 push 이벤트가 서비스 워커(있는 경우)로 디스패치됩니다. 이 객체는 선언적 푸시 메시지에 의해 기술됩니다.

선언적 푸시 메시지 파서 결과는 튜플로, notification(알림)과 mutable(불리언 값)로 구성됩니다.

선언적 푸시 메시지 파서는 byte sequence bytes, origin origin, URL baseURL, 그리고 EpochTimeStamp fallbackTimestamp를 인자로 받아 다음 절차를 실행합니다. 실패 또는 선언적 푸시 메시지 파서 결과 중 하나를 반환합니다.

1. message를 parse JSON bytes to an Infra value를 bytes에 대해 실행한 결과로 한다. 예외가 발생하면 실패를 반환한다.

2. message가 map이 아니면 실패를 반환한다.

3. message["web_push"]가 존재하지 않거나 8030이 아니면 실패를 반환한다.

4. message["notification"]가 존재하지 않으면 실패를 반환한다.

5. notificationInput를 message["notification"]로 한다.

6. notificationInput이 map이 아니면 실패를 반환한다.

7. notificationInput["title"]가 존재하지 않거나 문자열이 아니면 실패를 반환한다.

8. notificationInput["navigate"]가 존재하지 않거나 문자열이 아니면 실패를 반환한다.

9. notificationTitle를 notificationInput["title"]로 한다.

10. notificationOptions를 NotificationOptions 딕셔너리로 한다.

11. notificationInput["dir"]가 존재하고 값이 "auto", "ltr", "rtl" 중 하나라면, notificationOptions["dir"] 에 notificationInput["dir"] 값을 설정한다.

12. notificationInput["lang"]가 존재하고 문자열이면, notificationOptions["lang"] 에 notificationInput["lang"] 값을 설정한다.

13. notificationInput["body"]가 존재하고 문자열이면, notificationOptions["body"] 에 notificationInput["body"] 값을 설정한다.

14. notificationOptions["navigate"] 에 notificationInput["navigate"]를 변환하여 설정한다.

15. notificationInput["tag"]가 존재하고 문자열이면, notificationOptions["tag"] 에 notificationInput["tag"] 값을 설정한다.

16. notificationInput["image"]가 존재하고 문자열이면, notificationOptions["image"] 에 notificationInput["image"]를 변환하여 설정한다.

17. notificationInput["icon"]가 존재하고 문자열이면, notificationOptions["icon"] 에 notificationInput["icon"]를 변환하여 설정한다.

18. notificationInput["badge"]가 존재하고 문자열이면, notificationOptions["badge"] 에 notificationInput["badge"]를 변환하여 설정한다.

19. notificationInput["vibrate"]가 존재하고 list이며, 각 item이 32비트 부호 없는 정수라면, notificationOptions["vibrate"] 에 notificationInput["vibrate"]를 설정한다.

20. notificationInput["timestamp"]가 존재하고 64비트 부호 없는 정수이면, notificationOptions["timestamp"] 에 notificationInput["timestamp"]를 설정한다.

21. notificationInput["renotify"]가 존재하고 불리언 값이면, notificationOptions["renotify"] 에 notificationInput["renotify"]를 설정한다.

22. notificationInput["silent"]가 존재하고 불리언 값이면, notificationOptions["silent"] 에 notificationInput["silent"]를 설정한다.

23. notificationInput["requireInteraction"]가 존재하고 불리언 값이면, notificationOptions["requireInteraction"] 에 notificationInput["requireInteraction"]를 설정한다.

24. notificationInput["data"]가 존재하면 notificationOptions["data"] 에 convert an Infra value to a JSON-compatible JavaScript value를 notificationInput["data"]에 대해 실행한 결과를 설정한다.

25. notificationInput["actions"]가 존재하고 list라면:

    1. notificationActions를 « »로 한다.

    2. 각 actionInput에 대해 notificationInput["actions"]를 순회한다:

       1. actionInput["action"]가 존재하지 않거나 문자열이 아니면 continue.

       2. actionInput["title"]가 존재하지 않거나 문자열이 아니면 continue.

       3. actionInput["navigate"]가 존재하지 않거나 문자열이 아니면 continue.

       4. actionNavigate를 actionInput["navigate"]를 변환한 값으로 한다.

       5. notificationAction을 NotificationAction 딕셔너리 «[ "action" → actionInput["action"], "title" → actionInput["title"], "navigate" → actionNavigate ]»로 한다.

       6. actionInput["icon"]가 존재하고 문자열이면 notificationAction["icon"] 에 actionInput["icon"]를 변환하여 설정한다.

       7. Append notificationAction을 notificationActions에 추가한다.

    3. notificationOptions["actions"] 에 notificationActions를 설정한다.

26. notification을 create a notification을 notificationTitle, notificationOptions, origin, baseURL, fallbackTimestamp에 대해 실행한 결과로 한다. 예외가 발생하면 실패를 반환한다.

27. notification의 navigation URL이 null이면 실패를 반환한다.

28. notification의 actions에 있는 notification action의 navigation URL이 null이면 실패를 반환한다.

29. mutable을 false로 한다.

30. message["mutable"]가 존재하고 불리언 값이면 mutable을 message["mutable"] 값으로 설정한다.

31. (notification, mutable)를 반환한다.

사용자 에이전트나 푸시 서비스는 언제든지 갱신을 선택할 수 있습니다. 예를 들어, 일정 기간이 경과한 경우 등입니다.

이 경우 사용자 에이전트는 현재 푸시 구독을 생성할 때 사용된 PushSubscriptionOptions를 사용하여 반드시 푸시 구독 생성 단계를 실행해야 합니다. 새 푸시 구독은 반드시 원래 구독과 다른 키 쌍을 가져야 합니다.

성공하면 사용자 에이전트는 반드시 해당 서비스 워커 등록과 연결된 푸시 구독을 registration, 초기 푸시 구독을 oldSubscription, 새 푸시 구독을 newSubscription으로 하여 "pushsubscriptionchange" 이벤트를 반드시 발생시켜야 합니다.

애플리케이션 서버에 변경 사항이 전파될 시간을 허용하기 위해 사용자 에이전트는 갱신 후 잠시 동안 이전 푸시 구독에 대한 메시지를 계속 받을 수 있습니다. 갱신된 푸시 구독에 대한 메시지를 수신하면, 모든 이전 푸시 구독은 반드시 비활성화되어야 합니다.

사용자 에이전트가 푸시 구독을 갱신할 수 없는 경우, 주기적으로 갱신을 재시도해야 합니다. 푸시 구독을 더 이상 사용할 수 없는 경우(예: 만료된 경우), 사용자 에이전트는 반드시 해당 서비스 워커 등록과 연결된 푸시 구독을 registration, 비활성화되는 PushSubscription 인스턴스를 oldSubscription, null을 newSubscription으로 하여 "pushsubscriptionchange" 이벤트를 반드시 발생시켜야 합니다.

푸시 구독이 비활성화되면 사용자 에이전트와 푸시 서비스는 해당 정보의 저장된 복사본을 반드시 삭제해야 합니다. 이후 이 푸시 구독에 대한 푸시 메시지는 반드시 전달되지 않아야 합니다.

푸시 구독은 연결된 서비스 워커 등록이 등록 해제될 때 비활성화되지만, 푸시 구독은 더 일찍 비활성화될 수도 있습니다.

WebIDL[Exposed=ServiceWorker, SecureContext]
interface PushSubscriptionChangeEvent : ExtendableEvent {
  constructor(DOMString type, optional PushSubscriptionChangeEventInit eventInitDict = {});
  readonly attribute PushSubscription? newSubscription;
  readonly attribute PushSubscription? oldSubscription;
};

newSubscription 속성은 get 시 초기화된 값을 반환합니다.

oldSubscription 속성은 get 시 초기화된 값을 반환합니다.

WebIDLdictionary PushSubscriptionChangeEventInit : ExtendableEventInit {
  PushSubscription newSubscription = null;
  PushSubscription oldSubscription = null;
};

newSubscription 멤버는 푸시 구독이 pushsubscriptionchange 이벤트 발생 시점에 유효한 정보를 나타냅니다. 새 푸시 구독을 생성할 수 없는 경우(예: 명시적 허락 상실 등)는 값이 null입니다.

oldSubscription 멤버는 더 이상 사용해서는 안 되는 푸시 구독 정보를 나타냅니다. 사용자 에이전트가 전체 정보를 제공할 수 없는 경우(예: 데이터베이스 손상 등)는 값이 null입니다.