ActivityClient

​

Submódulos

• módulo xdk.activity.client
  • ActivityClient
    • ActivityClient.__init__()
    • ActivityClient.create_subscription()
    • ActivityClient.delete_subscription()
    • ActivityClient.get_subscriptions()
    • ActivityClient.stream()
    • ActivityClient.update_subscription()
• módulo 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

​

Contenido del módulo

Este módulo proporciona acceso a los endpoints de actividad de X API y sirve como punto de entrada principal para todas las funcionalidades relacionadas con la actividad.

​

class xdk.activity.ActivityClient

Cliente de streaming para operaciones de actividad

​

Parámetros

path.client · Client

​

__init__

​

Parámetros

path.client · Client

​

create_subscription

Crear una suscripción de actividad en X Crea una suscripción para un evento de actividad en X body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: CreateSubscriptionResponse

​

Parámetros

body.body · CreateSubscriptionRequest

​

delete_subscription

Elimina la suscripción a la actividad de X Elimina una suscripción a un evento de actividad de X

​

Parámetros

path.subscription_id · Any

El identificador de la suscripción que se eliminará.

​

Devuelve

DeleteSubscriptionResponse - Datos de la respuesta

​

get_subscriptions

Obtener las suscripciones de actividad de X Obtener una lista de suscripciones activas de XAA :returns: Datos de la respuesta :rtype: GetSubscriptionsResponse

​

Devuelve

GetSubscriptionsResponse

​

stream

Flujo de actividad (streaming) Flujo de actividades de X Este es un endpoint de streaming que entrega datos en tiempo real a medida que van estando disponibles. Cada elemento entregado representa un único punto de datos del flujo. La conexión se gestiona automáticamente con lógica de reintentos con backoff exponencial. Si el flujo se desconecta, el SDK se volverá a conectar automáticamente sin intervención por parte del cliente.

​

Parámetros

path.backfill_minutes · int or None · predeterminado: "None"

El número de minutos de backfill solicitados.

path.start_time · str or None · predeterminado: "None"

YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua desde la cual se proporcionarán las etiquetas de Publicación.

path.end_time · str or None · predeterminado: "None"

YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente desde la cual se proporcionarán las etiquetas de Publicación.

path.stream_config · StreamConfig

StreamConfig opcional para personalizar el comportamiento de reintento, los tiempos de espera y los callbacks.

​

update_subscription

Actualizar la suscripción de actividad en X Actualiza una suscripción para un evento de actividad en X

​

Parámetros

path.subscription_id · Any

El ID de la suscripción que se va a actualizar.

body.body · UpdateSubscriptionRequest

Cuerpo de la solicitud