شروع کار با «فعالیت زنده»

با Firebase Cloud Messaging HTTP v1 API، می‌توانید اعلان‌های فعالیت زنده را از راه دور در دستگاه‌های iOS ارسال، به‌روزرسانی، و متوقف کنید. توجه داشته باشید که برای استفاده از فعالیت Live به iOS 16.1 و برای شروع ازراه‌دور اعلان فعالیت Live به iOS 17.2 نیاز دارید.

قبل از شروع

قبل‌از شروع فعالیت زنده در Firebase Cloud Messaging، دستورالعمل‌های موجود در راه‌اندازی برنامه کارخواه Firebase Cloud Messaging در پلاتفرم‌های Apple را دنبال کنید تا Firebase Cloud Messaging را ایجاد و به برنامه کارخواه خود اضافه کنید.

شروع کردن فعالیت زنده

برای شروع کردن فعالیت زنده از راه دور بااستفاده از Firebase Cloud Messaging، باید کد push-to-start را از Apple دریافت کنید. همچنین به FCMکد ثبت برای برنامه هدف نیاز خواهید داشت.

برای ساختن بار داده‌ای که فعالیت زنده را شروع می‌کند، فیلد 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

اجرا

روی اجرا کلیک کنید تا نمونه را در API Explorer امتحان کنید.

به‌روزرسانی فعالیت Live

برای به‌روزرسانی فعالیت زنده از راه دور بااستفاده از Firebase Cloud Messaging، باید کد ارسال مستقیم را از Apple دریافت کنید. همچنین به FCMکد ثبت برای برنامه هدف نیاز خواهید داشت.

برای ساختن بار داده‌ای که «فعالیت Live» را به‌روز می‌کند، فیلد apns.payload را از نمونه کد زیر تکمیل کنید تا فعالیت Live را از راه دور بااستفاده از 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

اجرا

روی اجرا کلیک کنید تا نمونه را در API Explorer امتحان کنید.

پایان دادن به فعالیت زنده

برای پایان دادن به فعالیت زنده بااستفاده از Firebase Cloud Messaging، باید کد ارسال از Apple دریافت کنید. همچنین به FCMکد ثبت برای برنامه هدف نیاز خواهید داشت.

برای ساختن بار داده‌ای که فعالیت زنده را پایان می‌دهد، فیلد 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

اجرا

روی اجرا کلیک کنید تا نمونه را در API Explorer امتحان کنید.