Type Alias DocumentLocationResolver

Type declaration

• • (
        params: {
            id: string;
            perspectiveStack: StackablePerspective[];
            type: string;
            variant?: string;
            version: string | undefined;
        },
        context: { documentStore: DocumentStore },
    ):
        | DocumentLocationsState
        | null
        | undefined
        | Observable<DocumentLocationsState | null | undefined>

  • Parameters

    • params: {
          id: string;
          perspectiveStack: StackablePerspective[];
          type: string;
          variant?: string;
          version: string | undefined;
      }

      Object with document id and document type properties

      • id: string

      • perspectiveStack: StackablePerspective[]

      • type: string

      • Optionalvariant?: string

        The selected editing variant as a bare variant id, or undefined when no variant is selected. Pass it as the variant param in the client, alongside perspectiveStack.

      • version: string | undefined

    • context: { documentStore: DocumentStore }

      Object with documentStore property for creating listenQuery subscriptions

    Returns
        | DocumentLocationsState
        | null
        | undefined
        | Observable<DocumentLocationsState | null | undefined>

    Document location state, optionally as an Observable, or null/undefined if no locations are available