FacebookBatchQueue | messaging-apis

Hierarchy

FacebookBatchQueue

Index

Constructors

constructor

Properties

queue

Methods

Constructors

constructor

new FacebookBatchQueue(clientConfig: ClientConfig, options?: BatchConfig): FacebookBatchQueue

example

const client = new MessengerClient();
new FacebookBatchQueue(client);

new FacebookBatchQueue(client, {
  delay: 3000,
  shouldRetry: () => true,
  retryTimes: 3,
});

Parameters

clientConfig: ClientConfig
options: BatchConfig = {}

Optional batch config.

Returns FacebookBatchQueue

Properties

Readonly queue

queue: QueueItem[]

The queue to store facebook requests.

Methods

flush

flush(): Promise<void>

- Defined in facebook-batch/src/FacebookBatchQueue.ts:117
Flushes the queue proactively.

This queue has a timer to flush items at a time interval, so normally you don't need to call this method.
example
```
await bq.flush();
```
Returns Promise<void>

push

push<T>(request: BatchRequest): Promise<T>

Pushes a facebook request into the queue.

example

await bq.push({
  method: 'POST',
  relativeUrl: 'me/messages',
  body: {
    messagingType: 'UPDATE',
    recipient: 'PSID',
    message: { text: 'Hello World' },
  },
});
//=> {
//  recipientId: '...',
//  messageId: '...',
// }

Type parameters

T: JsonValue = any

Parameters

request: BatchRequest
The request to be queued.

Returns Promise<T>

A promise resolves the response of the request.

stop

stop(): void

- Defined in facebook-batch/src/FacebookBatchQueue.ts:171
Stops the internal timer.
example
```
bq.stop();
```
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

clientConfig: ClientConfig

options: BatchConfig = {}

Returns FacebookBatchQueue

Properties

Readonly queue

Methods

flush

Returns Promise<void>

push

Type parameters

T: JsonValue = any

Parameters

request: BatchRequest

Returns Promise<T>

stop

Returns void