ISummaryNack Interface
Packages > @fluidframework/driver-definitions > ISummaryNack
Contents of summary nack expected from the server.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/driver-definitions/legacy.
For more information about our API support guarantees, see here .
Signature
export interface ISummaryNack
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| code |
Alpha
|
optional
|
number | An error code number that represents the error. It will be a valid HTTP error code. 403 errors are non retriable. 400 errors are always immediately retriable. 429 errors are retriable or non retriable (depends on type field). |
| message |
Alpha
|
optional
|
string | A message about the error for debugging/logging/telemetry purposes |
| retryAfter |
Alpha
|
optional
|
number | Optional Retry-After time in seconds. If specified, the client should wait this many seconds before retrying.8 |
| summaryProposal |
Alpha
|
ISummaryProposal | Information about the proposed summary message. |
Property Details
code
An error code number that represents the error. It will be a valid HTTP error code. 403 errors are non retriable. 400 errors are always immediately retriable. 429 errors are retriable or non retriable (depends on type field).
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
code?: number;
Type: number
message
A message about the error for debugging/logging/telemetry purposes
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
message?: string;
Type: string
retryAfter
Optional Retry-After time in seconds. If specified, the client should wait this many seconds before retrying.8
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
retryAfter?: number;
Type: number
summaryProposal
Information about the proposed summary message.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
summaryProposal: ISummaryProposal;
Type: ISummaryProposal