איך מתחילים להפעיל את ההגדרה 'פעילות בשידור חי'

‫HTTP v1 API של Firebase Cloud Messaging מאפשר לשלוח, לעדכן ולסיים מרחוק התראות על פעילות בשידור חי במכשירי iOS. שימו לב: כדי להשתמש בפעילות בזמן אמת, צריך מערכת הפעלה iOS מגרסה 16.1 ומעלה. כדי להפעיל מרחוק התראה על פעילות בזמן אמת, צריך מערכת הפעלה iOS מגרסה 17.2 ומעלה.

לפני שמתחילים

לפני שמתחילים להשתמש בתכונה 'פעילות בזמן אמת' ב-Firebase Cloud Messaging, צריך לפעול לפי ההוראות במאמר הגדרת אפליקציית לקוח של Firebase Cloud Messaging בפלטפורמות של אפל כדי ליצור את Firebase Cloud Messaging ולהוסיף אותו לאפליקציית הלקוח.

התחלת פעילות בשידור חי

כדי להתחיל פעילות בזמן אמת מרחוק באמצעות Firebase Cloud Messaging, צריך לקבל מאפל אסימון של push-to-start. תצטרכו גם את FCM token לרישום של אפליקציית היעד.

כדי ליצור payload שמתחיל פעילות במצב לייב, צריך למלא את השדה apns.payload מקוד הדוגמה הבא כדי להתחיל מרחוק פעילות במצב לייב באמצעות FCM.

REST

{
"message": {
  "token": "FCM_TOKEN",
  "apns": {
    "live_activity_token": "LIVE_ACTIVITY_PUSH_TO_START_TOKEN",
    "headers": {
      "apns-priority": "10"
    },
    "payload": {
      "aps": {
        "timestamp": TIMESTAMP,
        "event": "start",
        "content-state": {
          "demo": 1
        },
        "attributes-type": "DemoAttributes",
        "attributes": {
          "demoAttribute": 1
        },
        "alert": {
          "title": "test title",
          "body": "test body"
        }
      }
    }
  }
}
}

cURL

curl -X POST -H "Authorization: Bearer OAUTH2_ACCESS_TOKEN" -H "Content-Type: application/json" -d '{
"message": {
"token": "FCM_TOKEN",
"apns": {
  "live_activity_token": "LIVE_ACTIVITY_PUSH_TO_START_TOKEN",
  "headers": {
    "apns-priority": "10"
  },
  "payload": {
    "aps": {
      "timestamp": TIMESTAMP,
      "event": "start",
      "content-state": {
        "demo": 1
      },
      "attributes-type": "DemoAttributes",
      "attributes": {
        "demoAttribute": 1
      },
      "alert": {
        "title": "test title",
        "body": "test body"
      }
    }
  }
}
}
}' https://fcm.googleapis.com/v1/projects/YOUR_PROJECT_ID/messages:send

Run

לוחצים על Run כדי לנסות את הדוגמה ב-API Explorer.

עדכון פעילות בזמן אמת

כדי לעדכן מרחוק פעילות בזמן אמת באמצעות Firebase Cloud Messaging, צריך לקבל טוקן push מ-Apple. תצטרכו גם את FCM token לרישום של אפליקציית היעד.

כדי ליצור payload לעדכון פעילות בזמן אמת, צריך למלא את השדה apns.payload בדוגמת הקוד הבאה כדי לעדכן מרחוק פעילות בזמן אמת באמצעות FCM.

REST

{
"message": {
  "token": "FCM_TOKEN",
  "apns": {
    "live_activity_token": "LIVE_ACTIVITY_PUSH_TOKEN",
    "headers": {
      "apns-priority": "10"
    },
    "payload": {
      "aps": {
        "timestamp": TIMESTAMP,
        "event": "update",
        "content-state": {
          "test1": 100,
          "test2": "demo"
        },
        "alert": {
          "title": "test title",
          "body": "test body"
        }
      }
    }
  }
}
}

cURL

curl -X POST -H "Authorization: Bearer OAUTH2_ACCESS_TOKEN" -H "Content-Type: application/json" -d '{
"message": {
"token": "FCM_TOKEN",
"apns": {
  "live_activity_token": "LIVE_ACTIVITY_PUSH_TOKEN",
  "headers": {
    "apns-priority": "10"
  },
  "payload": {
    "aps": {
      "timestamp": TIMESTAMP,
      "event": "update",
      "content-state": {
        "test1": 100,
        "test2": "demo"
      },
      "alert": {
        "title": "test title",
        "body": "test body"
      }
    }
  }
}
}
}' https://fcm.googleapis.com/v1/projects/YOUR_PROJECT_ID/messages:send

Run

לוחצים על Run כדי לנסות את הדוגמה ב-API Explorer.

איך מסיימים פעילויות בזמן אמת

כדי לסיים פעילות בזמן אמת באמצעות Firebase Cloud Messaging, צריך לקבל push token מאפל. תצטרכו גם את FCM token לרישום של אפליקציית היעד.

כדי ליצור payload שמסיים פעילות במצב לייב, ממלאים את השדה apns.payload בדוגמת הקוד הבאה כדי לסיים מרחוק פעילות במצב לייב באמצעות FCM.

REST

{
"message": {
  "token": "FCM_TOKEN",
  "apns": {
    "live_activity_token": "LIVE_ACTIVITY_PUSH_TOKEN",
    "headers": {
      "apns-priority": "10"
    },
    "payload": {
      "aps": {
        "timestamp": TIMESTAMP,
        "dismissal-date": DISMISSAL_DATE,
        "event": "end",
        "content-state": {
          "test1": 100,
          "test2": "demo"
        },
        "alert": {
          "title": "test title",
          "body": "test body"
        }
      }
    }
  }
}
}

cURL

curl -X POST -H "Authorization: Bearer OAUTH2_ACCESS_TOKEN" -H "Content-Type: application/json" -d '{
"message": {
"token": "FCM_TOKEN",
"apns": {
  "live_activity_token": "LIVE_ACTIVITY_PUSH_TOKEN",
  "headers": {
    "apns-priority": "10"
  },
  "payload": {
    "aps": {
      "timestamp": TIMESTAMP,
      "dismissal-date": DISMISSAL_DATE,
      "event": "end",
      "content-state": {
        "test1": 100,
        "test2": "demo"
      },
      "alert": {
        "title": "test title",
        "body": "test body"
      }
    }
  }
}
}
}' https://fcm.googleapis.com/v1/projects/YOUR_PROJECT_ID/messages:send

Run

לוחצים על Run כדי לנסות את הדוגמה ב-API Explorer.