OCP App SDK / ChannelRateLimit

ChannelRateLimit

Defines a rate limit for channel delivery in to form of per
where unit is second, minute, hour, day, or of seconds.
E.g., count: 100, period: 15, unit: second => 100 per 15 seconds

Index

Properties

• count
• grouping
• period
• unit

Properties

count

number

The number of delivery requests (batches) per period of time

Defined in: src/app/types/AppManifest.ts:95

grouping

"app" | "install"

Whether this rate limit applies to the app as a whole or per each install

Defined in: src/app/types/AppManifest.ts:107

period

number

The number of units of time to measure the rate limit over

Defined in: src/app/types/AppManifest.ts:99

unit

"second" | "minute" | "hour" | "day"

The unit of time applied to the perioid

Defined in: src/app/types/AppManifest.ts:103