ChannelRateLimit
7 min
OCP App SDK / ChannelRateLimit
Interface: ChannelRateLimit
Defined in: src/app/types/AppManifest.ts:140
Defines a rate limit for channel delivery in to form of <count> per <n> <unit> where unit is second, minute, hour, day, or <number> 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:144
The number of delivery requests (batches) per period of time
grouping
grouping: "app" | "install"
Defined in: src/app/types/AppManifest.ts:156
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:148
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:152
The unit of time applied to the period