ActivityClient

Client para operações de activity Este client fornece métodos para interagir com os endpoints activity da X API. Ele cuida da autenticação, formatação de requisição e análise de resposta para todas as operações relacionadas a activity.

​

Construtores

​

constructor

• new ActivityClient(client): ActivityClient Cria uma nova instância do client activity

​

Parâmetros

​

Retorna

ActivityClient

​

Definido em

activity/client.ts:118

​

Métodos

​

getSubscriptions

▸ getSubscriptions(options): Promise<Response> Get X activity subscriptions Get a list of active subscriptions for XAA

​

Parâmetros

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

activity/client.ts:159 ▸ getSubscriptions(): Promise<ActivitySubscriptionGetResponse>

​

Retorna

Promise<ActivitySubscriptionGetResponse>

​

Definido em

activity/client.ts:168

---

​

createSubscription

▸ createSubscription(options): Promise<Response> Create X activity subscription Creates a subscription for an X activity event

​

Parâmetros

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

activity/client.ts:237 ▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>

​

Parâmetros

​

Retorna

Promise<ActivitySubscriptionCreateResponse>

​

Definido em

activity/client.ts:246

---

​

stream

▸ stream(options): Promise<Response> Activity Stream Stream of X Activities

​

Parâmetros

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

activity/client.ts:332 ▸ stream(options?): Promise<ActivityStreamingResponse>

​

Parâmetros

​

Retorna

Promise<ActivityStreamingResponse>

​

Definido em

activity/client.ts:341

---

​

updateSubscription

▸ updateSubscription(subscriptionId, options): Promise<Response> Update X activity subscription Updates a subscription for an X activity event

​

Parâmetros

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

activity/client.ts:487 ▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>

​

Parâmetros

​

Retorna

Promise<ActivitySubscriptionUpdateResponse>

​

Definido em

activity/client.ts:500

---

​

deleteSubscription

▸ deleteSubscription(subscriptionId, options): Promise<Response> Deletes X activity subscription Deletes a subscription for an X activity event

​

Parâmetros

​

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

​

Definido em

activity/client.ts:602 ▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>

​

Parâmetros

​

Retorna

Promise<ActivitySubscriptionDeleteResponse>

​

Definido em

activity/client.ts:615