cs-icon.svg

React Native Delivery SDK

Contentstack ist ein headless CMS mit einem API-first-Ansatz. Es ist ein CMS, mit dem Entwickler leistungsstarke plattformübergreifende Anwendungen in ihren bevorzugten Sprachen erstellen können. Erstellen Sie Ihr Anwendungs-Frontend, und Contentstack kümmert sich um den Rest. Weiterlesen.

Contentstack provides React Native Delivery SDK to build application on top of React Native. Given below is the detailed guide and helpful resources to get started with our React Native Delivery SDK.

Voraussetzung

You need Node.js version 4.4.7 or later installed to use the Contentstack JavaScript Delivery SDK.

Einrichtung und Installation

React Native uses the Javascript SDK to create apps. To use the JavaScript Delivery SDK, install ist via npm:

npm i contentstack

Um das SDK in Ihr Projekt zu importieren, verwenden Sie den folgenden Befehl:

import Contentstack from 'contentstack/react-native'

To initialize the SDK, you will need to specify the API Key, Delivery Token, and Environment Name of your stack.

const Stack = Contentstack.Stack({ "api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment" });

To initialize the SDK for the Europe, Azure NA, Azure EU, or GCP NA region, refer to the code below:

FOR EU

const Stack = Contentstack.Stack({"api_key":"api_key","delivery_token":"delivery_token","environment":"environment","region":Contentstack.Region.EU});

FOR AZURE_EU

const Stack = Contentstack.Stack({"api_key":"api_key","delivery_token":"delivery_token","environment":"environment","region":Contentstack.Region.AZURE_EU});

FOR AZURE_NA

const Stack = Contentstack.Stack({"api_key":"api_key","delivery_token":"delivery_token","environment": "environment", "region": Contentstack.Region.AZURE_NA});

FOR GCP_NA

const Stack = Contentstack.Stack({"api_key":"api_key","delivery_token":"delivery_token","environment":"environment","region":Contentstack.Region.GCP_NA});

Schnellstart in 5 Minuten

Initialisieren Sie Ihr SDK

You will need to specify the API key, Access token, and Environment Name of your stack to initialize the SDK:

const Stack = Contentstack.Stack({ "api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment" });

Sobald Sie das SDK initialisiert haben, können Sie damit beginnen, Inhalte in Ihre App zu laden.

Abfragen von Inhalten aus Ihrem Stack

Um einen einzelnen Eintrag zu erhalten, müssen Sie den Inhaltstyp sowie die ID des Eintrags angeben.

const Stack = Contentstack.Stack({ "api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment" });
const entry = Stack.ContentType('blog').Entry("entry_uid");
const result = await entry.fetch()

Hinweis: Wir haben eine Abfragemethode für eine bestimmte Sprache. Betrachten Sie beispielsweise die folgende Abfrage:

Stack.ContentType('content_type_uid').Query().language('fr-fr').toJSON().find()

Es werden alle Einträge eines Inhaltstyps bereitgestellt, der im französischen Gebietsschema veröffentlicht wurde.

Um mehrere Einträge eines Inhaltstyps abzurufen, müssen Sie die UID des Inhaltstyps angeben. Sie können auch suchen angeben, um Ergebnisse zu filtern.

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment" });
const Query = Stack.ContentType('blog').Query();
Query.where("title", "welcome")
.includeSchema()
.includeCount()
.toJSON()
.find()
.then((result) => {

})
.catch((error))=> {

});
Hinweis:
  • Derzeit unterstützt das JavaScript SDK nicht die Referenzierung mehrerer Inhaltstypen in einer einzigen Abfrage. Weitere Informationen zum Abfragen von Einträgen und Assets finden Sie im Abschnitt „Abfragen“ unserer Dokumentation zur Content Delivery API.
  • Standardmäßig beträgt der Grenzwert für Antwortdetails pro Anfrage 100, wobei der Höchstwert auf 250 festgelegt ist.

Antworten paginieren

In einem einzigen Fall ruft die Abfrage "Mehrere Einträge abrufen" nur die ersten 100 Einträge des angegebenen Inhaltstyps ab. Sie können paginieren und den Rest der Einträge stapelweise abrufen, indem Sie die skip und limit Parameter in nachfolgenden Anfragen.

const Stack = Contentstack.Stack({ "api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment" });
let blogQuery = Stack.ContentType('example').Query();
blogQuery.skip(20).limit(20).find()
.then((result) => {

}).catch((error))=> {

});

Abfragen von Assets aus Ihrem Stapel

Um ein einzelnes Asset zu erhalten, müssen Sie die UID des Assets angeben.

const Stack = Contentstack.Stack({ "api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment" });
const Asset = Stack.Asset("asset_uid");
Asset.fetch()
.then((result) => {

}).catch((error))=> {

});

Um mehrere Assets abzurufen. Sie können auch suchen angeben, um Ergebnisse zu filtern.

const Stack = Contentstack.Stack({ "api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment" });
const Query = Stack.Asset().Query();
Query
.limit(20)
.toJSON()
.find()
.then(function success(result) {

}, function error(err) {

});

Cache-Richtlinien

Sie können eine Cache-Richtlinie für einen Stack und/oder ein Abfrageobjekt festlegen.

Festlegen einer Cache-Richtlinie für einen Stack

Mit dieser Option können Sie eine Cache-Richtlinie globalisieren. Dies bedeutet, dass die von Ihnen festgelegte Cache-Richtlinie auf alle Abfrageobjekte des Stapels angewendet wird.

//Setting a cache policy on a stack
Stack.setCachePolicy(Contentstack.CachePolicy.NETWORK_ELSE_CACHE)
Festlegen einer Cache-Richtlinie für ein Abfrageobjekt

Mit dieser Option können Sie eine Cache-Richtlinie für ein bestimmtes Abfrageobjekt festlegen/überschreiben.

// setting a cache policy on a queryobject
Query.setCachePolicy(Contentstack.CachePolicy.CACHE_THEN_NETWORK)

Contentstack

Erstellt eine Instanz von „Contentstack“.

NameTypDescription

CachePolicy

Contentstack.CachePolicy

CachePolicy enthält verschiedene Cache-Richtlinienkonstanten.

Standard: Contentstack.CachePolicy.IGNORE_CACHE

Stapel

Kehrt zurück:
Typ
Stapel
NameTypDescription

api_key (erforderlich)

Zeichenfolge

Stack-API-Schlüssel

Liefertoken

Zeichenfolge

Stack- Bereitstellung -Token.

Umfeld

Zeichenfolge

Name der Stack-Umgebung.

Region

ContentstackRegion | Zeichenfolge

DB region for Stack. You can choose from five regions namely, NA, EU, Azure NA, Azure EU, and GCP NA.

Zweig

Zeichenfolge

Name des Zweigs, von dem Sie Daten abrufen möchten

Live Vorschau

Objekt

Live-Vorschau-Konfiguration.

fetchOptions.debug

Boolescher Wert

Optional, um Debug-Protokolle zu aktivieren, die auf „true“ gesetzt sind.

Standard: falsch

fetchOptions.logHandler

Funktion

Eine Protokollhandlerfunktion zum Verarbeiten bestimmter Protokollmeldungen und -fehler.

fetchOptions.agent

HttpProxyAgent

fetchOptions.timeout

Nummer

Legen Sie eine Zeitüberschreitung für die Anfrage fest.

fetchOptions.retryLimit

Nummer

Die Anzahl der Wiederholungsversuche bis zum Scheitern.

Standard: 5

fetchOptions.retryDelay

Nummer

Die Anzahl der ms, die für Vorgangswiederholungen verwendet werden sollen.

Standard: 300 ms

fetchOptions.retryCondition

Funktion

Eine Funktion, um zu bestimmen, ob der Fehler wiederholt werden kann.

Standard: Erneut versuchen erfolgt bei den Statuscodes 408, 429

fetchOptions.retryDelayOptions.base

Nummer

Die Basisanzahl an Millisekunden, die im exponentiellen Backoff für Vorgangswiederholungen verwendet werden soll.

fetchOptions.retryDelayOptions.customBackoff

Nummer

Eine benutzerdefinierte Funktion, die einen Wiederholungszähler und einen Fehler akzeptiert und die Verzögerungszeit in Millisekunden zurückgibt.

Stapel initialisieren:

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({ api_key: 'api_key', delivery_token: 'delivery_token', environment: 'environment' });

To set the European, Azure North American, Azure European, or GCP North America region, refer to the code below:

import Contentstack from 'contentstack';
const Stack = new Contentstack({ 'api_key': "api_key", 'delivery_token': "delivery_token", 'environment': "environment", "region": Contentstack.Region.<<add_your_region>>})

Zum Festlegen der Verzweigung für eine Region.

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({ api_key: 'api_key', delivery_token: 'delivery_token', environment: 'environment', region: Contentstack.Region.<<add_your_region>>, host: '<<add_your_host_URL>>', branch: 'branch')

Proxy-Konfiguration

const Stack = Contentstack.Stack({ 
    api_key: 'api_key', 
    delivery_token: 'delivery_token', 
    environment: 'environment',
    URL: URL,
    fetchOptions: {
       fetch: `proxy-url`
    }
});

Hier sind einige Beispiele, wie Sie HttpProxyAgent einen Benutzernamen und ein Passwort hinzufügen können.

  • Sie können es in der URI übergeben:
var proxyAgent = new HttpsProxyAgent('https://username:password@your-proxy.com');
  • Sie können es in der Authentifizierungsoption festlegen
var proxyOpts = url.parse('https://your-proxy.com');
proxyOpts.auth = 'username:password';
var proxyAgent = new HttpsProxyAgent(proxyOpts);
  • Sie können den HTTP-Header sogar manuell festlegen:
var proxyOpts = url.parse('https://your-proxy.com');
proxyOpts.headers = {
  'Proxy-Authentication': 'Basic ' + new Buffer('username:password').toString('base64')
};
var proxyAgent = new HttpsProxyAgent(proxyOpts);

Plugins

When creating custom plugins, through this request, you can pass the detailss of your custom plugins. This facilitates their utilization in subsequent requests when retrieving details.

// custom class for plugin
class CrossStackPlugin {
  onRequest (stack, request) {
    // request modifications
    return request
  }
  async onResponse (stack, request, response, data) {
    // response modifications here
    return response
  }
}

const Stack = Contentstack.Stack({
  api_key,
  delivery_token,
  environment,
  plugins: [
    new CrossStackPlugin(),
    new Livepreview()
  ]
});

Stapel

Initialisieren Sie eine Instanz von „Stack“
NameTypDescription

param.api_key (erforderlich)

Zeichenfolge

Stack-API-Schlüssel.

param.delivery_token (erforderlich)

Zeichenfolge

Stack- Bereitstellung -Token.

param.environment (erforderlich)

Zeichenfolge

Name der Stack-Umgebung.

setProtocol

Legt das Protokoll für den Host fest
Kehrt zurück:
Typ
Stapel
NameTypDescription

Protokoll

Zeichenfolge

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
Stack.setProtocol('https');

setHost

Legt den Host des API-Servers fest

Kehrt zurück:
Typ
Stapel
NameTypDescription

Gastgeber

Zeichenfolge

Legt den Host des API-Servers fest

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
Stack.setHost('custom.contentstack.com');

setPort

Legt den Port des Hosts fest
Kehrt zurück:
Typ
Stapel
NameTypDescription

Hafen

Nummer

import Contentstack from 'contentstack'
const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
SStack.setPort(443);

setCachePolicy

Ermöglicht das Festlegen von Cache-Richtlinien
Kehrt zurück:
Typ
Stapel
NameTypDescription

Taste

Contentstack.CachePolicy

Standard: Contentstack.CachePolicy.ONLY_NETWORK
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
Stack.setCachePolicy(Contentstack.CachePolicy.IGNORE_CACHE);

setCacheProvider

Kehrt zurück:
Typ
Stapel
import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
Stack.setCacheProvider({
  get: function (key, callback) {
    try {
        callback(null, <cache_provider>.get(key));
    } catch(e) {
        callback(e);
    }
  },
  set: function (key, value, callback) {
    try {
        if(key && value) <cache_provider>.set(key, value);
        callback();
    } catch(e) {
        callback(e);
    }
  }
});

getCacheProvider

Gibt das aktuell festgelegte Objekt von „CacheProvider“ zurück.


import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
Stack.getCacheProvider();

Vermögenswerte

Ruft standardmäßig alle Assets eines Stapels ab. Um ein einzelnes Asset abzurufen, geben Sie dessen UID an.
Kehrt zurück:
Typ
Vermögenswerte
NameTypDescription

uid

Zeichenfolge

UID des Assets

So erhalten Sie alle Assets vom Stapel:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack;/Assets().Query().toJSON().find();

To specific Asset from the stack with uid:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.Assets('asset_uid').toJSON().find();

Inhaltstyp

Legen Sie den Inhaltstyp fest, dessen Einträge Sie abrufen möchten
Kehrt zurück:
Typ
Stapel
NameTypDescription

content_type_uid

Zeichenfolge

UID des vorhandenen Inhaltstyps

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.ContentType('content_type_uid').Query().toJSON().find()

getContentTypes

Diese Methode gibt umfassende Informationen zu allen Inhaltstypen eines bestimmten Stapels in Ihrem Konto zurück.

Kehrt zurück:
Typ
Versprechen
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
Const result = await Stack.getContentTypes({"include_global_field_schema": true});

getLastActivities

getLastActivities get all the ContentTypes whose last activity updated.
Kehrt zurück:
Typ
Versprechen
import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.getLastActivities().toJSON().fetch();

Taxonomien

Legen Sie die Basis-URL für den Taxonomien-Endpunkt fest.

Beispiel:

import Contentstack from 'contentstack';
const stack = Contentstack.stack('api_key', 'delivery_token', 'environment');

let data;
stack
.Taxonomies()
.where("taxonomies.taxonomy_uid", "term_uid")
.toJSON()
.find()
.then(response => {
  // the response
  data = response;
})

Query

Ein Initialisierer ist für die Erstellung eines Abfrageobjekts verantwortlich. Bietet Unterstützung für alle suchen
Kehrt zurück:
Typ
Query

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.ContentType('content_type_uid').Query().toJSON().find();

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.Assets().Query().toJSON().find();

imageTransform

Führt Transformationen an Bildern der genannten URL basierend auf Transformationsparametern durch

Kehrt zurück:
Typ
Zeichenfolge
NameTypDescription

URL

Zeichenfolge

Bild URL, auf die Transformationen angewendet werden müssen.

Parameter

Objekt

Objekt mit Transformationsparametern

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
Stack.imageTransform(imageURL, {height: 100, width: 200, disable: "upscale"});
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
Stack.imageTransform(imageURL, {crop: "150,100"});
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
Stack.imageTransform(imageURL, {format: "png", crop: "150,100"});

synchronisieren

Synchronisiert Ihre Contentstack Daten mit Ihrer App und stellt durch die Bereitstellung von Delta-Updates sicher, dass die Daten immer auf dem neuesten Stand sind
Kehrt zurück:
Typ
Versprechen
NameTypDescription

param.init

Boolescher Wert

Initialisierung der Synchronisierung

param.locale

Zeichenfolge

Initialisierung der Synchronisierung mit Einträgen eines bestimmten Gebietsschemas

param.start_date

Zeichenfolge

Standard: Initialisierung der Synchronisierung mit Einträgen, die nach einem bestimmten Datum veröffentlicht werden

param.content_type_uid

Zeichenfolge

Initialisierung der Synchronisierung mit Einträgen eines bestimmten Inhaltstyps

Parametertyp

Zeichenfolge

Verwenden Sie den Typparameter, um einen bestimmten Inhaltstyp abzurufen. Unterstützt „asset_published“, „entry_published“, „asset_unpublished“, „entry_unpublished“, „asset_deleted“, „entry_deleted“, „content_type_deleted“.

param.pagination_token

Zeichenfolge

Abrufen des nächsten Stapels von Einträgen mithilfe des Paginierungstokens

param.sync_token

Zeichenfolge

Durchführen einer nachfolgenden Synchronisierung nach der ersten Synchronisierung

Zum Initialisieren der Synchronisierung:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.sync({'init': true});

Zum Initialisieren der Synchronisierung mit Einträgen eines bestimmten Gebietsschemas:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.sync({'init': true, 'locale': 'en-us'});

So initialisieren Sie die Synchronisierung mit Einträgen, die nach einem bestimmten Datum veröffentlicht wurden:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.sync({'init': true, 'start_date': '2018-10-22'});

Zum Initialisieren der Synchronisierung mit Einträgen eines bestimmten Inhaltstyps:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.sync({'init': true, 'content_type_uid': 'session'});

Für Initialisierung der Synchronisierung mit spezifischer Typ:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.sync({'init': true, 'type': 'entry_published'});

Zum Abrufen des nächsten Stapels von Einträgen mithilfe des Paginierungstokens:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.sync({'pagination_token': '<page_token>'});

So führen Sie eine nachfolgende Synchronisierung nach der ersten Synchronisierung durch:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({"api_key": "api_key", "delivery_token": "delivery_token", "environment": "environment"});
const result = await Stack.sync({'sync_token': '<sync_token>'}) 

Vermögenswerte

Erstellt eine Instanz von „Assets“.

Ruft standardmäßig alle Assets eines Stapels ab. Um ein einzelnes Asset abzurufen, geben Sie dessen UID an.

NameTypDescription

uid

Zeichenfolge

UID des Assets, das Sie abrufen möchten

addParam

Kehrt zurück:
Typ
Vermögenswerte
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.Assets('asset_uid').addParam('include_dimension', 'true').toJSON().fetch()

toJSON

Converts your response into plain JavasScript object

Kehrt zurück:
Typ
Vermögenswerte|Eintrag|Abfrage
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().toJSON().find()
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.Assets().Query().toJSON().find()
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').toJSON().fetch()
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.Assets('asset_uid').toJSON().fetch()

bringen

Ruft ein bestimmtes Asset basierend auf der bereitgestellten Asset-UID ab.
Kehrt zurück:
Typ
Versprechen
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.Assets('asset_uid').addParam('include_dimension', 'true').toJSON().fetch()

Wo

Die Methode where() ruft die Assets unter Verwendung einer beliebigen anderen Feld-UID der Assets aus dem Stapel ab.

Kehrt zurück:
Typ
Vermögenswerte
NameTypDescription

Feldname (erforderlich)

Zeichenfolge

Feld UID des Assets

Wert (erforderlich)

Zeichenfolge

Wert des Vermögenswerts

Beispiel:

import Contentstack from 'contentstack'
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.Assets().Query().where('field_name', "value").toJSON().find()

Eintrag

Ein Initialisierer ist für die Erstellung des Entry-Objekts verantwortlich.
NameTypDescription

UID (erforderlich)

Zeichenfolge

UID des Eintrags

Sprache

Legt den Sprachcode fest, dessen Daten Sie abrufen möchten.
Kehrt zurück:
Typ
Eintrag
NameTypDescription

Sprachcode

Zeichenfolge

Sprachcode. z. B. „en-us“, „ja-jp“ usw.

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').language('language_code').toJSON().fetch();

addParam

Bezieht Abfrageparameter in Ihre Abfragen ein.

Kehrt zurück:
Typ
Eintrag
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').addParam('include_count', 'true').toJSON().fetch()

addQuery

Fügt eine Abfrage zum Entry-Objekt hinzu

Kehrt zurück:
Typ
Eintrag
NameTypDescription

Taste

Zeichenfolge

Schlüssel der Abfrage

Wert

beliebig

Wert der Abfrage

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').addQuery('include_content_type', true).toJSON().fetch();

only

Zeigt nur Werte der angegebenen Felder von Einträgen oder Assets in der Antwort an
Kehrt zurück:
Typ
Eintrag
NameTypDescription

Werte

string|array

Die einzige Funktion mit field_uid schließt für jeden Eintrag nur die Daten der angegebenen Felder ein und schließt die Daten aller anderen Felder aus.

import Contentstack from 'contentstack'; 
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').only('title').toJSON().fetch();

Die einzige Funktion mit einem Array von field_uids schließt mehrere Felder für jeden Eintrag ein und schließt die Daten aller anderen Felder aus.

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').only(['title', 'description']).toJSON().fetch();

In nur haben wir den nur mit einem Referenzparameter, bei dem Sie die UID des Referenzfeldes anstelle von "reference_field_uid" eingeben müssen, und den zweiten Parameter, um nur die Daten des angegebenen field_uid für jeden Eintrag einzuschließen und die Daten aller anderen Felder auszuschließen.

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeReference('reference_field_uid').only('reference_field_uid','title').toJSON().fetch();

In nur haben wir den nur mit einem Referenzparameter mit einem Array, bei dem Sie die UID des Referenzfeldes anstelle von "reference_field_uid" eingeben müssen, und den zweiten Parameter mit einem Array von Feldern, um nur die Daten des angegebenen Arrays von field_uids für jeden Eintrag aufzunehmen und die Daten aller anderen Felder auszuschließen.

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeReference('reference_field_uid').only('reference_field_uid',['title', 'description']).toJSON().fetch();

außer

Zeigt alle Daten eines Eintrags oder Vermögens an, mit Ausnahme der Daten der angegebenen Felder.
Kehrt zurück:
Typ
Eintrag
NameTypDescription

Werte

string|array

Die Ausnahmefunktion mit field_uid schließt für jeden Eintrag nur die Daten der angegebenen Felder aus und schließt die Daten aller anderen Felder ein.

import Contentstack from 'contentstack'; 
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').except('title').toJSON().fetch();

Die Ausnahmefunktion mit einem Array von field_uids schließt mehrere Felder für jeden Eintrag aus und schließt die Daten aller anderen Felder ein.

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').except(['title', 'description']).toJSON().fetch();

In außer haben wir nur einen Referenzparameter, bei dem Sie anstelle von „reference_field_uid“ die UID des Referenzfelds eingeben müssen, und den zweiten Parameter, um für jeden Eintrag nur die Daten der angegebenen field_uid auszuschließen und die Daten einzuschließen aller anderen Bereiche.

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeReference('reference_field_uid').except('reference_field_uid','title').toJSON().fetch();

Allerdings haben wir nur den Parameter mit einem Referenzfeld mit einem Array, bei dem Sie die UID des Referenzfeldes anstelle von "reference_field_uid" eingeben müssen, und den zweiten Parameter mit einem Array von Feldern, um nur die Daten des angegebenen Arrays von field_uids für jeden Eintrag auszunehmen und die Daten aller anderen Felder einzuschließen.

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeReference('reference_field_uid').except('reference_field_uid',['title', 'description']).toJSON().fetch();

includeReference

Ruft den gesamten Inhalt des referenzierten Eintrags ab.

Kehrt zurück:
Typ
Eintrag
NameTypDescription

Wert

string|array

Referenz mit reference_field_uids als Array einschließen:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeReference(['reference_field_uid','other_reference_field_uid']).toJSON().fetch();

Schließen Sie die Referenz mit reference_field_uids und der untergeordneten Referenz ein

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeReference(['reference_field_uid', 'reference_field_uid.child_reference_field_uid']).toJSON().fetch();

Referenz mit reference_field_uid einschließen:

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeReference('reference_field_uid').toJSON().fetch();

includeEmbeddedItems

Fügen Sie eingebettete Objekte (Einträge und Assets) zusammen mit den Eintragsdetails hinzu.
Kehrt zurück:
Typ
Eintrag
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeEmbeddedItems().toJSON().fetch();

includeContentType

Geben Sie die Details des Inhaltstyps zusammen mit den Eintragsdetails an.

Kehrt zurück:
Typ
Eintrag
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeContentType().toJSON().fetch();

includeBranch

Schließen Sie den Zweig zum Veröffentlichen von Inhalten ein.

Kehrt zurück:
Typ
Eintrag
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Entry('entry_uid').includeBranch().toJSON().fetch();

includeFallback

Schließen Sie den Veröffentlichungsinhalt des Fallback-Gebietsschemas ein, wenn der angegebene Gebietsschemainhalt nicht veröffentlicht wird.

Kehrt zurück:
Typ
Eintrag
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
Stack.ContentType('content_type_uid;).Entry('entry_uid').includeFallback().fetch()

Taxonomie

Mithilfe der Taxonomie können Sie Inhalte in Ihrem Stapel kategorisieren, um die Navigation und das Abrufen von Informationen zu erleichtern.

Note: All methods in the Query section are applicable for taxonomy-based filtering as well.

equalAndBelow

Die Methode equalAndBelow ruft alle Einträge für eine bestimmte Taxonomie ab, die mit einem bestimmten Begriff und allen seinen Nachkommenbegriffen übereinstimmen, wobei nur der Zielbegriff erforderlich ist.

Note: This query is applicable for the stack.Taxonomies() and stack.ContentType('uid').Query() methods.

Kehrt zurück:
Typ
Query
NameTypDescription

Schlüssel (erforderlich)

Zeichenfolge

UID des Taxonomiefelds, angegeben als „Taxonomien“.<taxonomy_uid> "

Wert (erforderlich)

Zeichenfolge

UID des abzugleichenden oder zu vergleichenden Begriffs

Ebenen

int

Tiefenebene, bis zu der Begriffe abgeglichen werden

Beispiel:

let data;
stack
.ContentType('ct_uid')
.Query()
.equalAndBelow("taxonomies.taxonomy_uid", "term_uid", 3)
.toJSON()
.find()
.then(response => {
  // the response
  data = response;
})

unten

Die folgende Methode ruft alle Einträge für eine bestimmte Taxonomie ab, die mit allen untergeordneten Begriffen übereinstimmen, indem nur der Zielbegriff und eine bestimmte Ebene angegeben werden.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Kehrt zurück:
Typ
Query
NameTypDescription

Schlüssel (erforderlich)

Zeichenfolge

UID des Taxonomiefelds, angegeben als „Taxonomien“.<taxonomy_uid> "

Wert (erforderlich)

Zeichenfolge

UID des abzugleichenden oder zu vergleichenden Begriffs

Ebenen

int

Tiefenebene, bis zu der Begriffe abgeglichen werden

Beispiel:

let data;
stack
.ContentType('ct_uid')
.Query()
.below("taxonomies.taxonomy_uid", "term_uid", 3)
.toJSON()
.find()
.then(response => {
  // the response
  data = response;
})

Gleich und höher

Die Methode „equalAndAbove“ ruft alle Einträge für eine bestimmte Taxonomie ab, die mit einem bestimmten Begriff und allen seinen Vorgängerbegriffen übereinstimmen. Dafür sind nur der Zielbegriff und eine angegebene Ebene erforderlich.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Kehrt zurück:
Typ
Query
NameTypDescription

Schlüssel (erforderlich)

Zeichenfolge

UID des Taxonomiefelds, angegeben als „Taxonomien“.<taxonomy_uid> "

Wert (erforderlich)

Zeichenfolge

UID des abzugleichenden oder zu vergleichenden Begriffs

Ebenen

int

Tiefenebene, bis zu der Begriffe abgeglichen werden

Beispiel:

let data;
stack
.Taxonomies()
.equalAndAbove("taxonomies.taxonomy_uid", "term_uid", 3)
.toJSON()
.find()
.then(response => {
  // the response
  data = response;
})

über

Die obige Methode ruft alle Einträge für eine bestimmte Taxonomie ab, die nur mit dem/den übergeordneten Begriff(en) eines angegebenen Zielbegriffs übereinstimmen, mit Ausnahme des Zielbegriffs selbst und einer angegebenen Ebene.

Note: If you don't specify the level, the default behavior is to retrieve terms up to level 10.

Kehrt zurück:
Typ
Query
NameTypDescription

Schlüssel (erforderlich)

Zeichenfolge

UID des Taxonomiefelds, angegeben als „Taxonomien“.<taxonomy_uid> "

Wert (erforderlich)

Zeichenfolge

UID des abzugleichenden oder zu vergleichenden Begriffs

Ebenen

int

Tiefenebene, bis zu der Begriffe abgeglichen werden

Beispiel:

let data;
stack
.ContentType('ct_uid')
.Query()
.above("taxonomies.taxonomy_uid", "term_uid", 3)
.toJSON()
.find()
.then(response => {
  // the response
  data = response;
})

Query

Ein Initialisierer ist für die Erstellung eines Abfrageobjekts verantwortlich. Bietet Unterstützung für alle suchen

addParam

Bezieht Abfrageparameter in Ihre Abfragen ein.

Kehrt zurück:
Typ
Query
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().addParam('include_count', 'true').toJSON().find()

Nicht gleichzusetzen mit

Ruft Einträge ab, in denen der Wert für ein Feld nicht mit dem angegebenen Wert übereinstimmt.

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

UID des Feldes

Wert

beliebig

Wert, der zum Abgleichen oder Vergleichen verwendet wird

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().notEqualTo('title', 'some random title').toJSON().find();

Enthalten in

Rufen Sie Einträge ab, in denen der Wert eines Felds mit einem der bereitgestellten Wertearrays übereinstimmt

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

UID des Feldes

Wert

Array

Array von Werten, die zum Abgleichen oder Vergleichen verwendet werden sollen

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().containedIn('title', ['Demo', 'Welcome']).toJSON().find();

notContainedIn

Rufen Sie Einträge ab, in denen der Wert eines Felds mit keinem der bereitgestellten Wertearrays übereinstimmt.

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

UID des Feldes

Wert

Array

Array von Werten, die zum Abgleichen oder Vergleichen verwendet werden sollen

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().notContainedIn('title', ['Demo', 'Welcome']).toJSON().find();

und

Rufen Sie Einträge ab, die alle angegebenen Bedingungen erfüllen.

Kehrt zurück:
Typ
Query
NameTypDescription

Abfragen

Array

Array von Abfrageobjekten oder Rohabfragen

und mit Query-Instanzen:

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});

const Query1 = Stack.ContentType('content_type_1').Query().where('title', 'demo');
const Query2 = Stack.ContentType('content_type_1').Query().lessThan('age', 30);

const result = await Stack.ContentType('content_type_uid').Query().and(Query1, Query2).toJSON().find();

und mit Rohabfragen:

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});

const Query1 = Stack.ContentType('content_type_1').Query().where('title', 'demo').getQuery();
const Query2 = Stack.ContentType('content_type_1').Query().lessThan('age', 30).getQuery();

const result = await Stack.ContentType('content_type_uid').Query().and(Query1, Query2).toJSON().find();

oder

Ruft Einträge ab, die mindestens eine der angegebenen Bedingungen erfüllen

Kehrt zurück:
Typ
Query
NameTypDescription

Abfragen

Array

Array von Abfrageobjekten oder Rohabfragen

oder mit Query-Instanzen:

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});

const Query1 = Stack.ContentType('content_type_1').Query().where('title', 'demo');
const Query2 = Stack.ContentType('content_type_1').Query().lessThan('age', 30);

const result = await Stack.ContentType('content_type_uid').Query().or(Query1, Query2).toJSON().find();

oder mit Rohabfragen:

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});

const Query1 = Stack.ContentType('content_type_1').Query().where('title', 'demo').getQuery();
const Query2 = Stack.ContentType('content_type_1').Query().lessThan('age', 30).getQuery();

const result = await Stack.ContentType('content_type_uid').Query().or(Query1, Query2).toJSON().find();

weniger als

Ruft Einträge ab, in denen der Wert eines Felds kleiner als der angegebene Wert ist

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

UID des Feldes

Wert

beliebig

Wert, der zum Abgleichen oder Vergleichen verwendet wird

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().lessThan('age', 20).toJSON().find();

Gleich oder kleiner als

Ruft Einträge ab, in denen der Wert eines Felds kleiner oder gleich dem angegebenen Wert ist.

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

UID des Feldes

Wert

beliebig

Wert, der zum Abgleichen oder Vergleichen verwendet wird

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().lessThanOrEqualTo('age', 20).toJSON().find();

größer als oder gleich wie

Ruft Einträge ab, in denen der Wert für ein Feld größer oder gleich dem angegebenen Wert ist.

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

UID des Feldes

Wert

beliebig

Wert, der zum Abgleichen oder Vergleichen verwendet wird

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().greaterThanOrEqualTo('age', 20).toJSON().find();

Grenze

Gibt basierend auf dem festgelegten Limit eine bestimmte Anzahl von Einträgen zurück

Kehrt zurück:
Typ
Query
NameTypDescription

Grenze

Nummer

maximale Anzahl der zurückzugebenden Einträge

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().limit(20).toJSON().find();

aufsteigend

Sortieren Sie abgerufene Einträge in aufsteigender Reihenfolge in Bezug auf ein bestimmtes Feld.

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

Feld-UID, auf deren Grundlage die Bestellung durchgeführt wird

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().ascending('field_uid').toJSON().find();

absteigend

Sortieren Sie abgerufene Einträge in absteigender Reihenfolge in Bezug auf ein bestimmtes Feld

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

Feld-UID, auf deren Grundlage die Bestellung durchgeführt wird

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().descending('field_uid').toJSON().find();

existiert

Rufen Sie Einträge ab, wenn der Wert des in der Bedingung genannten Feldes vorhanden ist.

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

UID des Feldes

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().exists('field_uid').toJSON().find();

existiert nicht

Rufen Sie Einträge ab, wenn der in der Bedingung genannte Wert des Felds nicht vorhanden ist.

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

UID des Feldes

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().notExists('field_uid').toJSON().find();

only

Zeigt nur Werte der angegebenen Felder von Einträgen oder Assets in der Antwort an
Kehrt zurück:
Typ
Query
NameTypDescription

Werte

string|array

Die einzige Funktion mit field_uid schließt für jeden Eintrag nur die Daten der angegebenen Felder ein und schließt die Daten aller anderen Felder aus.

import Contentstack from 'contentstack'; 
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().only('title').toJSON().find();

Die einzige Funktion mit einem Array von field_uids schließt mehrere Felder für jeden Eintrag ein und schließt die Daten aller anderen Felder aus.

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().only(['title', 'description']).toJSON().find();

In nur haben wir den nur mit einem Referenzparameter, bei dem Sie die UID des Referenzfeldes anstelle von "reference_field_uid" eingeben müssen, und den zweiten Parameter, um nur die Daten des angegebenen field_uid für jeden Eintrag einzuschließen und die Daten aller anderen Felder auszuschließen.

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeReference('reference_field_uid').only('reference_field_uid','title').toJSON().find();

In nur haben wir den nur mit einem Referenzparameter mit einem Array, bei dem Sie die UID des Referenzfeldes anstelle von "reference_field_uid" eingeben müssen, und den zweiten Parameter mit einem Array von Feldern, um nur die Daten des angegebenen Arrays von field_uids für jeden Eintrag aufzunehmen und die Daten aller anderen Felder auszuschließen.

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeReference('reference_field_uid').only('reference_field_uid',['title', 'description']).toJSON().find();

außer

Zeigt alle Daten eines Eintrags oder Vermögens an, mit Ausnahme der Daten der angegebenen Felder.
Kehrt zurück:
Typ
Query
NameTypDescription

Werte

string|array

Die Ausnahmefunktion mit field_uid schließt für jeden Eintrag nur die Daten der angegebenen Felder aus und schließt die Daten aller anderen Felder ein.

import Contentstack from 'contentstack'; 
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().except('title').toJSON().find();

Die Ausnahmefunktion mit einem Array von field_uids schließt mehrere Felder für jeden Eintrag aus und schließt die Daten aller anderen Felder ein.

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().except(['title', 'description']).toJSON().find();

In außer haben wir nur einen Referenzparameter, bei dem Sie anstelle von „reference_field_uid“ die UID des Referenzfelds eingeben müssen, und den zweiten Parameter, um für jeden Eintrag nur die Daten der angegebenen field_uid auszuschließen und die Daten einzuschließen aller anderen Bereiche.

import Contentstack from 'contentstack';
const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeReference('reference_field_uid').except('reference_field_uid','title').toJSON().find();

Allerdings haben wir nur den Parameter mit einem Referenzfeld mit einem Array, bei dem Sie die UID des Referenzfeldes anstelle von "reference_field_uid" eingeben müssen, und den zweiten Parameter mit einem Array von Feldern, um nur die Daten des angegebenen Arrays von field_uids für jeden Eintrag auszunehmen und die Daten aller anderen Felder einzuschließen.

import Contentstack from &'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeReference('reference_field_uid').except('reference_field_uid',['title', 'description']).toJSON().find();

Regex

Rufen Sie Einträge ab, die den bereitgestellten regulären Ausdrücken entsprechen

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

uid des Feldes

Wert

beliebig

Wert, der zum Abgleichen oder Vergleichen verwendet wird

Optionen

beliebig

Wert im Eintrag abgleichen oder vergleichen

Regex ohne Optionen

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().regex('title', '^Demo').toJSON().find();

Regex mit Optionen

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().regex('title', '^Demo', 'i').toJSON().find();

Stichworte

Retrieves entries based on the provided tags

Kehrt zurück:
Typ
Query
NameTypDescription

Werte

Array

Array von Tags

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().tags(['technology', 'business']).toJSON().find();

includeReference

Ruft den gesamten Inhalt des referenzierten Eintrags ab.

Kehrt zurück:
Typ
Query
NameTypDescription

Wert

string|array

Referenz mit reference_field_uids als Array einschließen:

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeReference(['reference_field_uid','other_reference_field_uid']).toJSON().find();

Schließen Sie die Referenz mit reference_field_uids und der untergeordneten Referenz ein

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeReference(['reference_field_uid', 'reference_field_uid.child_reference_field_uid']).toJSON().find();

Referenz mit reference_field_uid einschließen:

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeReference('reference_field_uid').toJSON().find();

ReferenzIn

Retrieve entries based on raw queries

Kehrt zurück:
Typ
Query
NameTypDescription

fieldUid

Zeichenfolge

Referenzfeld-Uid

query

Objekt

RAW-Abfragen (JSON).

referenceIn mit Query-Instanzen

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});

const Query1 = Stack.ContentType('content_type_1').Query().where('title', 'Demo');

const result = await Stack.ContentType('content_type_uid').Query().referenceIn('brand', Query1).toJSON().find();

referenceIn mit Rohabfragen:

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});

const result = await Stack.ContentType('content_type_uid').Query().referenceIn('brand', {'title': 'Demo'}).toJSON().find();

referenceNotIn

Retrieve entries based on raw queries

Kehrt zurück:
Typ
Query
NameTypDescription

fieldUid

Zeichenfolge

Referenzfeld-Uid

query

Objekt

RAW-Abfragen (JSON).

referenceNotIn mit Query-Instanzen:

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});

const Query1 = Stack.ContentType('content_type_1').Query().where('title', 'Demo');

const result = await Stack.ContentType('content_type_uid').Query().referenceNotIn('brand', Query1).toJSON().find();

referenceNotIn mit Rohabfragen:

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().referenceNotIn('brand', {'title': 'Demo'}).toJSON().find();

includeReferenceContentTypeUID

Diese Methode umfasst auch die Inhaltstyp-UIDs der in der Antwort zurückgegebenen referenzierten Einträge.

Kehrt zurück:
Typ
Query
import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeReferenceContentTypeUID().toJSON().find();

includeCount

Enthält die Gesamtzahl der in der Antwort zurückgegebenen Einträge.

Kehrt zurück:
Typ
Query
import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeCount().toJSON().find();

includeContentType

Geben Sie die Details des Inhaltstyps zusammen mit den Eintragsdetails an.

Kehrt zurück:
Typ
Query
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeContentType().toJSON().find();

includeBranch

Schließen Sie den Zweig zum Veröffentlichen von Inhalten ein.

Kehrt zurück:
Typ
Query
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeBranch().toJSON().find();

includeEmbeddedItems

Fügen Sie eingebettete Objekte (Einträge und Assets) zusammen mit den Eintragsdetails hinzu.
Kehrt zurück:
Typ
Query
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().includeEmbeddedItems().toJSON().find();

includeFallback

Schließen Sie den Veröffentlichungsinhalt des Fallback-Gebietsschemas ein, wenn der angegebene Gebietsschemainhalt nicht veröffentlicht wird.

Kehrt zurück:
Typ
Eintrag
import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
Stack.ContentType('content_type_uid;).Query().includeFallback().fetch()

query

Retrieve entries based on raw queries

Kehrt zurück:
Typ
Query
NameTypDescription

query

Objekt

RAW-Abfragen (JSON).

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().query({'brand': {'$nin_query': {'title': 'Apple Inc.'}}}).toJSON().find();

addQuery

Fügt eine Abfrage zum Entry-Objekt hinzu

Kehrt zurück:
Typ
Query
NameTypDescription

Taste

Zeichenfolge

Schlüssel der Abfrage

Wert

beliebig

Wert der Abfrage

import Contentstack from 'contentstack'

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().addQuery('include_content_type', true).toJSON().find();

getQuery

Gibt die Rohabfrage (JSON) basierend auf den auf das Abfrageobjekt angewendeten Filtern zurück.

Kehrt zurück:
Typ
Query
import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const rawQuery = await Stack.ContentType('content_type_uid').Query().where('title', 'Demo').getQuery();

Sprache

Legt den Sprachcode fest, dessen Daten Sie abrufen möchten.
Kehrt zurück:
Typ
Query
NameTypDescription

Sprachcode

Zeichenfolge

Sprachcode. z. B. „en-us“, „ja-jp“ usw.

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().language('language_code').toJSON().find();

finden

Retrieves entries that satisfied the specified query

Kehrt zurück:
Typ
Versprechen
NameTypDescription

param

Objekt

Abrufoptionen zum Abrufen einer bestimmten Abfrage

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().toJSON().find();

einen finden

Retrieves entries that satisfied the specified query

Kehrt zurück:
Typ
Versprechen
NameTypDescription

param

Objekt

Abrufoptionen zum Abrufen einer bestimmten Abfrage

import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().toJSON().findOne();

count

Gibt die Gesamtzahl der Einträge zurück

Kehrt zurück:
Typ
Query
import Contentstack from 'contentstack';

const Stack = Contentstack.Stack({'api_key': 'api_key', 'delivery_token': 'delivery_token', 'environment': 'environment'});
const result = await Stack.ContentType('content_type_uid').Query().count().toJSON().find();

equalAndBelow

Die Methode equalAndBelow ruft alle Einträge für eine bestimmte Taxonomie ab, die mit einem bestimmten Begriff und allen seinen Nachkommenbegriffen übereinstimmen, wobei nur der Zielbegriff erforderlich ist.

Hinweis: Diese Abfrage ist für die Methoden stack.Taxonomies() und stack.ContentType('uid').Query() anwendbar.

Kehrt zurück:
Typ
Query
NameTypDescription

Schlüssel (erforderlich)

Zeichenfolge

UID des Taxonomiefelds, angegeben als „taxonomies.

Wert (erforderlich)

Zeichenfolge

UID des abzugleichenden oder zu vergleichenden Begriffs

Ebenen

int

Tiefenebene, bis zu der Begriffe abgeglichen werden

Beispiel:

let data;
stack
.ContentType('ct_uid')
.Query()
.equalAndBelow("taxonomies.taxonomy_uid", "term_uid", 3)
.toJSON()
.find()
.then(response => {
  // the response
  data = response;
})

unten

Die folgende Methode ruft alle Einträge für eine bestimmte Taxonomie ab, die mit allen untergeordneten Begriffen übereinstimmen, indem nur der Zielbegriff und eine bestimmte Ebene angegeben werden.

Hinweis: Wenn Sie die Ebene nicht angeben, werden standardmäßig Begriffe bis Ebene 10 abgerufen.

Kehrt zurück:
Typ
Query
NameTypDescription

Schlüssel (erforderlich)

Zeichenfolge

UID des Taxonomiefelds, angegeben als „taxonomies.

Wert (erforderlich)

Zeichenfolge

UID des abzugleichenden oder zu vergleichenden Begriffs

Ebenen

int

Tiefenebene, bis zu der Begriffe abgeglichen werden

Beispiel:

let data;
stack
.ContentType('ct_uid')
.Query()
.below("taxonomies.taxonomy_uid", "term_uid", 3)
.toJSON()
.find()
.then(response => {
  // the response
  data = response;
})

Gleich und höher

Die Methode „equalAndAbove“ ruft alle Einträge für eine bestimmte Taxonomie ab, die mit einem bestimmten Begriff und allen seinen Vorgängerbegriffen übereinstimmen. Dafür sind nur der Zielbegriff und eine angegebene Ebene erforderlich.

Hinweis: Wenn Sie die Ebene nicht angeben, werden standardmäßig Begriffe bis Ebene 10 abgerufen.

Kehrt zurück:
Typ
Query
NameTypDescription

Schlüssel (erforderlich)

Zeichenfolge

UID des Taxonomiefelds, angegeben als „taxonomies.

Wert (erforderlich)

Zeichenfolge

UID des abzugleichenden oder zu vergleichenden Begriffs

Ebenen

int

Tiefenebene, bis zu der Begriffe abgeglichen werden

Beispiel:

let data;
stack
.Taxonomies()
.equalAndAbove("taxonomies.taxonomy_uid", "term_uid", 3)
.toJSON()
.find()
.then(response => {
  // the response
  data = response;
})

über

Die obige Methode ruft alle Einträge für eine bestimmte Taxonomie ab, die nur mit dem/den übergeordneten Begriff(en) eines angegebenen Zielbegriffs übereinstimmen, mit Ausnahme des Zielbegriffs selbst und einer angegebenen Ebene.

Hinweis: Wenn Sie die Ebene nicht angeben, werden standardmäßig Begriffe bis Ebene 10 abgerufen.

Kehrt zurück:
Typ
Query
NameTypDescription

Schlüssel (erforderlich)

Zeichenfolge

UID des Taxonomiefelds, angegeben als „taxonomies.

Wert (erforderlich)

Zeichenfolge

UID des abzugleichenden oder zu vergleichenden Begriffs

Ebenen

int

Tiefenebene, bis zu der Begriffe abgeglichen werden

Beispiel:

let data;
stack
.ContentType('ct_uid')
.Query()
.above("taxonomies.taxonomy_uid", "term_uid", 3)
.toJSON()
.find()
.then(response => {
  // the response
  data = response;
})