ActivityClient

Client pour les opérations d’activité

Ce client fournit des méthodes pour interagir avec les endpoints d’activité de X API. Il gère l’authentification, le formatage des requêtes et l’analyse des réponses pour toutes les opérations liées à l’activité.

​

Constructeurs

​

constructor

• new ActivityClient(client): ActivityClient

Crée une nouvelle instance d’ActivityClient

​

Paramètres

Nom	Type	Description
client	Client	L’instance principale du Client X API

​

Renvoie

ActivityClient

​

Défini dans

activity/client.ts:118

​

Méthodes

​

getSubscriptions

▸ getSubscriptions(options): Promise<Response>

Récupère les abonnements d’activité à X Récupère une liste des abonnements actifs pour XAA

​

Paramètres

Nom	Type
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

​

Renvoie

Promise<Response>

Promise qui se résout en la réponse de l’API, ou en l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

activity/client.ts:159

▸ getSubscriptions(): Promise<ActivitySubscriptionGetResponse>

​

Renvoie

Promise<ActivitySubscriptionGetResponse>

​

Défini dans

activity/client.ts:168

---

​

createSubscription

▸ createSubscription(options): Promise<Response>

Créer un abonnement à l’activité sur X Crée un abonnement pour un événement d’activité sur X

​

Paramètres

Nom	Type
options	CreateSubscriptionOptions & { requestOptions: { raw: true } }

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

​

Défini dans

activity/client.ts:237

▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>

​

Paramètres

Nom	Type
options?	CreateSubscriptionOptions

​

Renvoie

Promise<ActivitySubscriptionCreateResponse>

​

Défini dans

activity/client.ts:246

---

​

stream

▸ stream(options): Promise<Response>

Flux d’activités Flux des activités sur X

​

Paramètres

Nom	Type
options	StreamOptions & { requestOptions: { raw: true } }

​

Valeur de retour

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou avec l’objet Response brut si requestOptions.raw est à true

​

Défini dans

activity/client.ts:332

▸ stream(options?): Promise<ActivityStreamingResponse>

​

Paramètres

Nom	Type
options?	StreamOptions

​

Renvoie

Promise<ActivityStreamingResponse>

​

Défini dans

activity/client.ts:341

---

​

updateSubscription

▸ updateSubscription(subscriptionId, options): Promise<Response>

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

​

Paramètres

Nom	Type	Description
subscriptionId	string	L’identifiant de l’abonnement à mettre à jour.
options	UpdateSubscriptionOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise se résolvant avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

activity/client.ts:487

▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>

​

Paramètres

Nom	Type
subscriptionId	string
options?	UpdateSubscriptionOptions

​

Retourne

Promise<ActivitySubscriptionUpdateResponse>

​

Défini dans

activity/client.ts:500

---

​

deleteSubscription

▸ deleteSubscription(subscriptionId, options): Promise<Response>

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

​

Paramètres

Nom	Type	Description
subscriptionId	string	L’identifiant de l’abonnement à supprimer.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

​

Défini dans

activity/client.ts:602

▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>

​

Paramètres

Nom	Type
subscriptionId	string

​

Renvoie

Promise<ActivitySubscriptionDeleteResponse>

​

Défini dans

activity/client.ts:615