ActivityClient

​

Sous-modules

• module xdk.activity.client
  • ActivityClient
    • ActivityClient.__init__()
    • ActivityClient.create_subscription()
    • ActivityClient.delete_subscription()
    • ActivityClient.get_subscriptions()
    • ActivityClient.stream()
    • ActivityClient.update_subscription()
• module xdk.activity.models
  • CreateSubscriptionRequest
    • CreateSubscriptionRequest.model_config
  • CreateSubscriptionResponse
    • CreateSubscriptionResponse.model_config
  • DeleteSubscriptionResponse
    • DeleteSubscriptionResponse.model_config
  • GetSubscriptionsResponse
    • GetSubscriptionsResponse.model_config
  • StreamResponse
    • StreamResponse.model_config
  • UpdateSubscriptionRequest
    • UpdateSubscriptionRequest.model_config
  • UpdateSubscriptionResponse
    • UpdateSubscriptionResponse.model_config

​

Contenu du module

Ce module donne accès aux endpoints d’activité de X API et constitue le point d’entrée principal pour toutes les fonctionnalités liées à l’activité.

​

class xdk.activity.ActivityClient

Client de streaming pour les opérations liées à l’activité

​

Paramètres

path.client · Client

​

__init__

​

Paramètres

path.client · Client

​

create_subscription

Créer un abonnement d’activité X Crée un abonnement pour un événement d’activité X body: Corps de la requête :returns: Données de réponse :rtype: CreateSubscriptionResponse

​

Paramètres

body.body · CreateSubscriptionRequest

​

delete_subscription

Supprime l’abonnement à l’activité sur X Supprime un abonnement à un événement d’activité sur X

​

Paramètres

path.subscription_id · Any

L’identifiant de l’abonnement à supprimer.

​

Renvoie

DeleteSubscriptionResponse - Données de la réponse

​

get_subscriptions

Récupérer les abonnements à l’activité X Récupérer la liste des abonnements actifs pour XAA :returns: Données de la réponse :rtype: GetSubscriptionsResponse

​

Valeur de retour

GetSubscriptionsResponse

​

stream

Flux d’activité (streaming) Flux d’activités sur X Il s’agit d’un endpoint de streaming qui émet des données en temps réel au fur et à mesure qu’elles sont disponibles. Chaque élément émis représente un point de données unique provenant du flux. La connexion est gérée automatiquement avec une logique de nouvelle tentative avec backoff exponentiel. Si le flux est interrompu, le SDK se reconnectera automatiquement sans intervention de l’utilisateur.

​

Paramètres

path.backfill_minutes · int or None · défaut: "None"

Le nombre de minutes d’historique à récupérer.

path.start_time · str or None · défaut: "None"

YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus ancien à partir duquel les libellés de Publication seront fournis.

path.end_time · str or None · défaut: "None"

YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC le plus récent à partir duquel les libellés de Publication seront fournis.

path.stream_config · StreamConfig

StreamConfig optionnel pour personnaliser le comportement de réessai, les délais d’expiration et les callbacks.

​

update_subscription

Mettre à jour l’abonnement à l’activité X
Met à jour un abonnement à un événement d’activité X

​

Paramètres

path.subscription_id · Any

L’identifiant de l’abonnement à mettre à jour.

body.body · UpdateSubscriptionRequest

Corps de la requête