API REFERENCE
SyGridAlignedGridsResult
Fields, allowed values, and APIs that use SyGridAlignedGridsResult.
Type definition
A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.
export interface SyGridAlignedGridsResult {
readonly status: 'joined' | 'left' | 'unchanged' | 'refused';
readonly group: string | null;
readonly reason: SyGridAlignedGridsRefusalReason | null;
readonly detail: string | null;
readonly seeded: boolean;
readonly members: ReadonlyArray<string>;
readonly mismatches: ReadonlyArray<SyGridAlignedMismatch>;
readonly peersConfigured: number;
}APIs using this type
- setAlignedGrids
Configures aligned Grid connections and returns the result.