Skip to main content

CreateGridResponse

Result of createGrid. This is a hybrid result rather than a thrown error: inspect error first. When error is NO_ERROR the call succeeded and grid is populated; otherwise grid is null and error explains why.

type CreateGridResponse {
  grid: Grid
  error: UdpErrorCode!
}

Fields​

CreateGridResponse.grid ● Grid object​

The created grid on success; null when error is non-zero.

CreateGridResponse.error ● UdpErrorCode! non-null enum​

A UDP-style error code (the same ErrorType enum the realtime/UDP servers use). NO_ERROR (0) means success; non-zero values describe the failure, e.g. NO_MATCHING_GRID_ASSIGNMENT, GRID_OUTSIDE_ASSIGNMENT, GRID_OVERLAPS_EXISTING, GRID_ALREADY_EXISTS, or UNKNOWN_ERROR.

Returned By​

createGrid mutation