Mar a tha Dà-chuairteachadh ag Obrachadh

Bidh API GraphQL Legalesign a’ cleachdadh dà-chuairteachadh stèidhichte air cuspair a rèir an sònrachadh ceangail Relay. Bidh gach liosta de nithean — sgrìobhainnean, teamplaidean, conaltraidhean, cunntasan — a’ cleachdadh an aon phàtran seo.

Am Pàtran ceangail

Tha an teirm-eòlas a’ tighinn bho theòiridh grafa — tha nòd nan puingean, agus tha oirthirean nan loidhnichean a cheanglas iad. San API, tha oirthir a’ mìneachadh an dàimh eadar dà sheòrsa agus faodaidh e metadata a bharrachd a ghiùlan (mar na ceadan a tha aig User ann an Group).

Nuair a chuireas tu iarrtas airson liosta, chan fhaigh thu raon fìor-ghlan. Gheibh thu ceangal le trì pàirtean:

documentConnection(first: 20) {
  documents { ... }     # the items (shortcut)
  totalCount            # total matching items
  pageInfo {            # pagination cursors
    startCursor
    endCursor
    hasNextPage
    hasPreviousPage
  }
}

Carson nach eil dìreach raon?

Tha dà-chuairteachadh stèidhichte air cuspair seasmhach. An àite dà-chuairteachadh ro-innleachdach (page=2), chan eil cuspairean a’ briseadh ma thèid nithean a chur ris no a thoirt air falbh eadar iarrtasan. Tha seo cudromach nuair a tha sgrìobhainnean gan cur agus a’ dol an sàs ann an àm fìor.

A’ faighinn a’ chiad duilleag

Cleachd first gus an àireamh de thoraidhean a chuingealachadh. Nuair a tha thu a’ dà-chuairteachadh tro bhuidheann toraid slàn ann am òrdugh cruthaichte, pasg "0" no "START" mar an argamaid after air an iarrtas agad a’ chiad uair gus comharrachadh gu bheil thu a’ tòiseachadh sreath dà-chuairteachaidh:

query {
  group(id: "grpYourGroupId") {
    documentConnection(first: 100, after: "0") {
      documents {
        id
        name
        status
        created
      }
      pageInfo {
        endCursor
        hasNextPage
      }
      totalCount
    }
  }
}

A’ faighinn an ath dhuilleag

Ma tha hasNextPage true, pasg endCursor mar an argamaid after:

query {
  group(id: "grpYourGroupId") {
    documentConnection(first: 100, after: "eyJpZCI6ImRvYzEyMyJ9") {
      documents {
        id
        name
        status
        created
      }
      pageInfo {
        endCursor
        hasNextPage
      }
      totalCount
    }
  }
}

Leanaidh tu orra gus am bi hasNextPage false.

Argamaidean Dà-chuairteachaidh

Gabhail ris na ceanglaichean uile na h-argamaidean seo:

Argamaid	Seòrsa	Tuairisgeul
first	Int	Àireamh nithean ri thoirt a-mach bhon toiseach
after	ID	Cuspair far am tòisich (airson dà-chuairteachadh air adhart)
last	Int	Àireamh nithean ri thoirt a-mach bhon deireadh
before	ID	Cuspair far an tòisich (airson dà-chuairteachadh air ais)

Tha a’ mhòr-chuid de cheanglaichean cuideachd a’ gabhail ri argamaidean sìoltachaidh sònraichte don seòrsa dàta. Mar eisimpleir, gabhail a-steach documentConnection from, to, status, search, sendType, agus sender.

Goirid-shlighe na h-Oirthirean

Bidh ceanglaichean a’ toirt seachad an dà chuid edges (le cuspair gach nì) agus liosta goirid-shlighe. Airson a’ mhòr-chuid de chùisean, tha an goirid-shlighe nas sìmplidhe:

# Shortcut — simpler, no per-item cursor
documentConnection(first: 20) {
  documents {
    id
    name
  }
  pageInfo {
    endCursor
    hasNextPage
  }
}

# Full edges — needed if you want per-item cursors
documentConnection(first: 20) {
  edges {
    node {
      id
      name
    }
    cursor
  }
  pageInfo {
    endCursor
    hasNextPage
  }
}

Cleachd an goirid-shlighe mura feum thu cuspairean fa leth (m.e. airson toirt air falbh nì sònraichte agus cuir ris an àite sin).

nota

Bidh totalCount a’ toirt air ais àireamh na duilleig làithreach, chan e aon iomlan thar gach duilleag. Tha cosgais toirt cunntas globaigeach thar milleanan de chlàran a’ dèanamh àireamh fìor iomlan doirbh.

Eisimpleir Fìor-dhaonna

Seo mar a tha app Console Legalesign a’ dà-chuairteachadh sgrìobhainnean a’ cleachdadh scroll gun chrìoch le TanStack Query:

query queryInfiniteDocuments {
  group(id: "grpYourGroupId") {
    documentConnection(
      first: 100
      after: "eyJpZCI6ImRvYzEyMyJ9"
      sendType: SINGLE
      from: "2025-01-01T00:00:00Z"
      to: "2025-06-01T00:00:00Z"
    ) {
      documents {
        id
        name
        status
        senderName
        created
        recipients {
          id
          email
          status
          signedDateTime
        }
      }
      pageInfo {
        endCursor
        hasNextPage
      }
      totalCount
    }
  }
}

Bidh an app ag iarraidh a’ chiad dhuilleag, an uairsin air scroll a’ cleachdadh endCursor mar after gus an ath phìos a luchdachadh.

Dè na Seòrsaichean a bhios a’ Cleachdadh Cheanglaichean?

Bidh gach dàimh liosta san API a’ cleachdadh am pàtran seo:

• Group.documentConnection, templateConnection, batchConnection, contactConnection, experienceConnection, scheduleConnection, attachmentConnection, memberConnection, invitationConnection, standardMessageConnection, contactGroupConnection, draftConnection, activityConnection
• Organisation.groupConnection, dataStopConnection, dataDeletionConnection, retentionConnection, userConnection, invoiceConnection, dataSubjectConnection
• Batch.documentConnection
• Billing.invoiceConnection
• Invoice.lineItemConnection
• Template.elementConnection, userSignatureConnection
• Document.elementConnection
• Recipient.elementConnection
• User.memberConnection, organisationConnection, supportTicketConnection