Premiers pas avec l'activité en direct

L'API HTTP v1 Firebase Cloud Messaging vous permet d'envoyer, de mettre à jour et de mettre fin à distance aux notifications d'activités en direct sur les appareils iOS. Notez que vous avez besoin d'iOS 16.1 pour utiliser les activités en direct et d'iOS 17.2 pour démarrer à distance une notification d'activité en direct.

Avant de commencer

Avant de commencer à utiliser les activités en direct sur Firebase Cloud Messaging, suivez les instructions de Configurer une application cliente Firebase Cloud Messaging sur les plates-formes Apple pour créer et ajouter Firebase Cloud Messaging à votre application cliente.

Démarrer une activité en direct

Pour démarrer une activité en direct à distance à l'aide de Firebase Cloud Messaging, vous devez obtenir un jeton de démarrage par pression auprès d'Apple. Vous aurez également besoin du jeton d'enregistrement FCM pour l'application cible.

Pour créer une charge utile qui démarre une activité en direct, renseignez le champ apns.payload de l'exemple de code suivant pour démarrer à distance une activité en direct à l'aide de 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

Exécuter

Cliquez sur Exécuter pour essayer l'exemple dans l'explorateur d'API.

Mettre à jour une activité en direct

Pour mettre à jour une activité en direct à distance à l'aide de Firebase Cloud Messaging, vous devez obtenir un jeton push auprès d'Apple. Vous aurez également besoin du jeton d'enregistrement FCM pour l'application cible.

Pour construire une charge utile qui met à jour une activité en direct, renseignez le champ apns.payload de l'exemple de code suivant pour mettre à jour à distance une activité en direct à l'aide de 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

Exécuter

Cliquez sur Exécuter pour essayer l'exemple dans l'explorateur d'API.

Mettre fin à une activité en direct

Pour mettre fin à une activité en direct à l'aide de Firebase Cloud Messaging, vous devez obtenir un jeton de notification push auprès d'Apple. Vous aurez également besoin du jeton d'enregistrement FCM pour l'application cible.

Pour construire une charge utile qui met fin à une activité en direct, renseignez le champ apns.payload de l'exemple de code suivant pour mettre fin à une activité en direct à distance à l'aide de 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

Exécuter

Cliquez sur Exécuter pour essayer l'exemple dans l'explorateur d'API.