EntityByGuidQuery

Interroger une liste d’entités par leur GUID.

Vous pouvez récupérer un maximum de 25 entités dans une requête.

Usage

import { EntityByGuidQuery } from 'nr1';

Exemples

Requête déclarative

<EntityByGuidQuery entityGuid={'MTIzNDU2fEZPT3xCQVJ8OTg3NjU0MzIx'}>
  {({ loading, error, data }) => {
    if (loading) {
      return <Spinner />;
    }

    if (error) {
      return 'Error!';
    }

    return (
      <List items={data.entities} rowHeight={20}>
        {({ item }) => <ListItem key={item.guid}>{item.name}</ListItem>}
      </List>
    );
  }}
</EntityByGuidQuery>;

Requête impérative

EntityByGuidQuery.query({
  entityGuid: 'MTIzNDU2fEZPT3xCQVJ8OTg3NjU0MzIx',
}).then(({ data }) => console.log(data));

Accessoires

children

fonction

Rendre la fonction prop comme un enfant.

function (queryResult: QueryResult Results of the query.
) => React.ReactNode

entityFragmentExtension

objet

Document fragment GraphQL analysé dans un AST par graphql-tag. Les composants de requête renvoient les champs les plus couramment utilisés disponibles sur une entité. Vous pouvez utiliser cet accessoire lorsque vous souhaitez demander des champs supplémentaires pour l'entité renvoyée par votre requête. Le fragment doit être nommé EntityFragmentExtension et s'appliquer au type EntityOutline .

const entityFragmentExtension = ngql`
  fragment EntityFragmentExtension on EntityOutline {
    indexedAt
    guid
  }
`;

entityGuid

OBLIGATOIRE

chaîne

GUID de l'entité à requêter.

fetchPolicyType

énum.

Vous permet de spécifier comment vous souhaitez que votre requête interagisse avec les données mises en cache.

CACHE_AND_NETWORK: La requête renvoie vos données initiales du cache si elles sont disponibles. Cependant, que les données complètes soient ou non dans votre cache, la requête effectue toujours une demande à l'aide de votre interface réseau et renvoie les données mises à jour. Cette option n'est pas disponible lors de l'utilisation de la méthode statique query() du composant.
CACHE_FIRST: La requête effectue une demande à l'aide de votre interface réseau uniquement si les données de votre requête ne sont pas déjà dans le cache.
CACHE_ONLY: La requête n'effectue jamais de demande à l'aide de votre interface réseau. Au lieu de cela, il renvoie les données disponibles dans le cache. Si les données de votre requête n'existent pas dans le cache, une erreur est générée.
NETWORK_ONLY: La requête ne renvoie jamais vos données initiales à partir du cache. Au lieu de cela, il fait toujours une demande en utilisant votre interface réseau.
NO_CACHE: La requête ne renvoie jamais vos données initiales à partir du cache. Au lieu de cela, il fait toujours une demande en utilisant votre interface réseau. Contrairement à la politique NETWORK_ONLY, aucune donnée n'est écrite dans le cache une fois la requête terminée.
<One ofEntityByGuidQuery.FETCH_POLICY_TYPE.CACHE_AND_NETWORK, EntityByGuidQuery.FETCH_POLICY_TYPE.CACHE_FIRST, EntityByGuidQuery.FETCH_POLICY_TYPE.CACHE_ONLY, EntityByGuidQuery.FETCH_POLICY_TYPE.NETWORK_ONLY, EntityByGuidQuery.FETCH_POLICY_TYPE.NO_CACHE, >

includeSummaryMetrics

booléen

includeTags

booléen

Si true, l'entité renvoyée inclut sa balise.

pollInterval

nombre

Intervalle en millisecondes pour interroger de nouvelles données. Réglez à zéro pour éviter tout type d'interrogation régulière.

skip

booléen

Lorsqu'il est défini sur true, la requête sera entièrement ignorée du rendu.

Méthodes