INackContent Interface

Interface for nack content.

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 INackContent

Properties

Property	Alerts	Modifiers	Type	Description
code	Alpha		number	An error code number that represents the error. It will be a valid HTTP error code. 403 errors are non retriable and client should acquire a new identity before reconnection. 400 errors are always immediately retriable 429 errors are retriable or non retriable (depends on type field).
message	Alpha		string	A message about the nack 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
type	Alpha		NackErrorType	Type of the Nack.

Property Details

code

An error code number that represents the error. It will be a valid HTTP error code. 403 errors are non retriable and client should acquire a new identity before reconnection. 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 nack 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

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

type

Type of the Nack.

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

type: NackErrorType;

Type: NackErrorType