ChannelRateLimit
OCP App SDK / ChannelRateLimit
Interface: ChannelRateLimit
Defined in: src/app/types/AppManifest.ts:108
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
Properties
count
count:
number
Defined in: src/app/types/AppManifest.ts:112
The number of delivery requests (batches) per period of time
grouping
grouping:
"app"
|"install"
Defined in: src/app/types/AppManifest.ts:124
Whether this rate limit applies to the app as a whole or per each install
period
period:
number
Defined in: src/app/types/AppManifest.ts:116
The number of units of time to measure the rate limit over
unit
unit:
"second"
|"minute"
|"hour"
|"day"
Defined in: src/app/types/AppManifest.ts:120
The unit of time applied to the perioid
Updated 3 days ago