line-bot-sdk-nodejs

Appearance

@line/bot-sdk

@line/bot-sdk / messagingApi / Limit

Type Alias: Limit ​

Limit = object

Defined in: lib/messaging-api/model/limit.ts:17

Limit of the Narrowcast

See ​

https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message

Properties ​

forbidPartialDelivery? ​

optional forbidPartialDelivery?: boolean

Defined in: lib/messaging-api/model/limit.ts:32

This option prevents messages from being delivered to only a subset of the target audience. If true, the narrowcast request success but fails asynchronously. You can check whether message delivery was canceled by retrieving the narrowcast message progress. This property can be set to true only if upToRemainingQuota is set to true.

Default ​

ts
false

max? ​

optional max?: number

Defined in: lib/messaging-api/model/limit.ts:22

The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random.

Minimum ​

1

upToRemainingQuota? ​

optional upToRemainingQuota?: boolean

Defined in: lib/messaging-api/model/limit.ts:27

If true, the message will be sent within the maximum number of deliverable messages. The default value is false. Targets will be selected at random.

Default ​

ts
false