Changelog

Contentstack - Android Delivery SDK

Android Delivery SDK for Contentstack

Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application front end, and Contentstack will take care of the rest. Read More.

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

Voraussetzung

To get started with Android SDK, you will the following:

Android Studio IDE
Android API SDK support 19 and above
Java SDK Version 1.8 oder höher

SDK-Installation und -Setup

Using Android Studio, you can easily add dependencies by opening the app's build.gradle file, under the dependencies section in the project:

dependencies{
    implementation 'com.contentstack.sdk:android:{version}'
}

You can download the latest dependency version here

Schnellstart in 5 Minuten

Initialisieren Sie Ihr SDK

Informationen zum Festlegen der Region finden Sie im folgenden Code:

import com.contentstack.sdk.*;
Config config = Config();
config.region = ContentstackRegion.EU;
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment", config);

Informationen zum Festlegen der Verzweigung finden Sie im folgenden Code:

import com.contentstack.sdk.*;

Config config = Config();
config.setBranch("branch");
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment", config);

Note: For Europe, set the region as EU, for Azure North America, Azure Europe, set the region as AZURE_NA and AZURE_EU respectively, and for GCP North America, set the region as GCP_NA.

Grundlegende Abfragen

Mit Contentstack SDKs können Sie mit den Inhalt Bereitstellung APIs interagieren und Inhalte von Contentstack abrufen. Sie sind schreibgeschützter Natur. Die SDKs rufen Inhalte vom nächstgelegenen Server über Fastly, unser leistungsstarkes und robustes CDN, ab und stellen sie bereit.

Holen Sie sich einen einzigen Eintrag

To retrieve a single entry from a content type, use the code snippet given below:

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");
ContentType contentType = stack.contentType("contentTypeUid");
Entry entry = contentType.entry("entryUid");
entry.fetch(new EntryResultCallBack(){	
@Override public void onCompletion(ResponseType responseType, Error error) {
   if (error == null) {
    System.out.println("response: "+entry.title);
 }}
});

Erhalten Sie mehrere Einträge

Um mehrere Einträge eines bestimmten Inhaltstyps abzurufen, verwenden Sie das unten angegebene Code-Snippet:

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");
Query query = stack.contentType("contentTypeUid").query();
query.find(new QueryResultsCallBack(){
@Override public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error){       
  if(error == null) { 
     System.out.println("response: "+entry.title);
  }
}
});

Hinweis:

Currently, the Android SDK does not support multiple content types referencing in a single query. For more information on how to query entries and assets, refer to the Queries section of our Content Delivery API documentation
Standardmäßig beträgt der Grenzwert für Antwortdetails pro Anfrage 100, wobei der Höchstwert auf 250 festgelegt ist.

Seitenzählung

In a single instance, the Get Multiple Entries query will retrieve only the first 100 items of the specified content type. You can paginate and retrieve the rest of the items in batches using the skip and limit parameters in subsequent requests.

import com.contentstack.sdk.*;
 
Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment"); 
Query query = stack.contentType("contentTypeUid").query();  
query.skip(20).limit(20).find(new QueryResultsCallBack(){  
  @Override  public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error){ 
   if(error == null){
     System.out.println("response: "+queryResult);
   }}  
});

Contentstack

Contentstack Klasse, die die Stack-Instanz verfügbar macht

Stapel

Eine Stack-Methode ermöglicht den Zugriff auf den Stack Ihrer Website. Es ermöglicht Benutzern stirbt Erhalten Sie den Inhalt in einem einzigen Bereich.

Kehrt zurück:

Typ

Stapel

Name	Typ	Beschreibung
context (required)	ApplicationContext	The application context
apiKey (erforderlich)	Zeichenfolge	API-Schlüssel Ihrer Anwendung auf Contentstack
DeliveryToken (erforderlich)	Zeichenfolge	Bereitstellung Tokens ruft nur die veröffentlichten Einträge der Umgebung ab, mit der es verknüpft ist
Umgebung (erforderlich)	Zeichenfolge	Eine Veröffentlichungsumgebung bezieht sich auf einen oder mehrere Bereitstellungsserver oder ein Inhaltsbereitstellungsziel (Adresse der Webseite), wo Sie Ihre Inhalte veröffentlichen (Einträge oder Vermögenswerte).
config	Konfig	Konfig Instanz, um Umgebungs- und andere Konfigurationsdetails festzulegen.

import com.contentstack.sdk.*;
 
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");

Beispiel mit Config:

import com.contentstack.sdk.*; 

Config config = new Config().setHost("api.contentstack.io");
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");

Konfig

Konfigurationsklasse, die eine Konfigurationsinstanz verfügbar macht, in der der Benutzer andere Konfigurationen auf dem Stapel bereitstellen kann

setBranch

Verzweigung für auf dem Stapel setzen

Kehrt zurück:

Typ

Leere

Name	Typ	Beschreibung
Zweig (erforderlich)	Zeichenfolge	Zweig, den Sie festlegen möchten

import com.contentstack.sdk.*;

Config config = new Config();
config.setBranch("branchName");
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment", config);

getBranch

Holen Sie sich den Zweig des Stapels

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Config config = new Config();
config.getBranch();
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

setProxy

Legt einen benutzerdefinierten Proxy fest

Kehrt zurück:

Typ

Leere

Name	Typ	Beschreibung
Proxy (erforderlich)	Stellvertreter	Proxy-Einstellung, normalerweise ein Typ (http, SOCKS) und eine Socket-Adresse. Ein Proxy ist ein unveränderliches Objekt

import com.contentstack.sdk.*;

java.net.Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxyHost", "proxyPort"));

java.net.Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("sl.theproxyvpn.io", 80));

Config config = new Config();

config.setProxy(proxy);

getProxy

Gibt die Proxy-Instanz zurück

Kehrt zurück:

Typ

Verbindungspool

import com.contentstack.sdk.*;

Config config = new Config()
config.getProxy()
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

getRegion

Erhalten Region der Anfrage-URL

Kehrt zurück:

Typ

ContentstackRegion

import com.contentstack.sdk.*;

Config config = new Config()
config.getRegion()
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

setRegion()

DB-Region für Ihren Stack. Sie können aus fünf Regionen wählen, nämlich NA, EU, Azure NA, Azure EU und GCP NA.

Kehrt zurück:

Typ

ContentstackRegion

Name	Typ	Beschreibung
Region (erforderlich)	ContentstackRegion	DB-Region für Ihren Stack. Sie können aus fünf Regionen wählen, nämlich NA, EU, Azure NA, Azure EU und GCP NA. Standard: ContentstackRegion. UNS

import com.contentstack.sdk.*;
Config config = new Config()
config.setRegion(ContentstackRegion.EU)
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

getHost()

Ruft den Host der Anfrage ab

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Config config = new Config()
config.getHost()
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

setHost()

Legen Sie den benutzerdefinierten Host der Anforderungs-URL fest

Kehrt zurück:

Typ

Zeichenfolge

Name	Typ	Beschreibung
Hostname (erforderlich)	Zeichenfolge	Der Wirt

import com.contentstack.sdk.*;

Config config = new Config()
config.sethost(hostname)
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

getVersion()

Ruft die Version des Anforderungspfads ab

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Config config = new Config()
config.getVersion()
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

enableLivePreview()

Aktiviert Live- Vorschau

Kehrt zurück:

Typ

Konfig

Name	Typ	Beschreibung
aktivieren (erforderlich)	Boolescher Wert	Geben Sie true an, um die Live- Vorschau zu aktivieren Standard: Falsch

import com.contentstack.sdk.*;

Config config = new Config()
config.enableLivePreview(true)
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

setLivePreviewHost()

Setzt Host auf die Live- Vorschau Anfrage-URL

Kehrt zurück:

Typ

Konfig

Name	Typ	Beschreibung
livePreviewHost (erforderlich)	Zeichenfolge	Host für Live- Vorschau

import com.contentstack.sdk.*;

Config config = new Config()
config.setLivePreviewHost(host)
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

setManagementToken()

Fügt dem Stack-Header ein Management-Token hinzu

Kehrt zurück:

Typ

Konfig

Name	Typ	Beschreibung
ManagementToken (erforderlich)	Zeichenfolge	Der Management-Token

import com.contentstack.sdk.*;

Config config = new Config()
config.setManagementToken(managementToken)
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

Früher Zugang

Mit der EarlyAccess-Header-Unterstützung können Sie auf Funktionen zugreifen, die Teil des Early Access-Programms sind.

Kehrt zurück:

Typ

Konfig

Beispiel:

Config config = new Config();
String[] earlyAccess = {"Taxonomy", "Teams", "Terms", "LivePreview"};
config.earlyAccess(earlyAccess);
stack = Contentstack.stack("apiKey", "deliveryToken", "environment", config);

Anlage

In Contentstack werden alle von Ihnen hochgeladenen Dateien (Bilder, Videos, PDFs, Audiodateien usw.) zur späteren Verwendung in Ihrem Repository gespeichert. Dieses Repository hochgeladener Dateien heißt Assets.

bringen

Rufen Sie alle im Stapel verfügbaren Assets ab

Kehrt zurück:

Typ

Leere

Name	Typ	Beschreibung
Rückruf (erforderlich)	FetchResultCallback	Rückruf der Asset-Antwort

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(applicationContext, "apiKey", "deliveryToken", "environment");
Asset asset = stack.asset("assetUid");
asset.fetch(new FetchResultCallback() {
@Override 
public void onCompletion(ResponseType responseType, Error error){

}}

includeBranch

Bezieht Branch in die Asset-Antwort ein

Kehrt zurück:

Typ

Anlage

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");
Asset asset = stack.asset("assetUid");
asset.includeBranch();

includeFallback

Beinhaltet eine Fallback-Sprache in der Asset-Antwort

Kehrt zurück:

Typ

Anlage

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.includeFallback();

includeMetadata

Includes Asset metadata along with the response body

Kehrt zurück:

Typ

Anlage

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");
final Asset asset = stack.asset("assetUid");
asset.includeMetadata();

addParam

Hinzufügen der Asset-Anfrage einen Abfrageparameter hinzu

Kehrt zurück:

Typ

Anlage

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Schlüssel des Headers, den Sie hinzufügen möchten
Wert (erforderlich)	Zeichenfolge	Fügen Sie dem Header einen Wert gegenüber dem Header-Schlüssel Hinzufügen

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.addParam();

includeDimension

Bezieht Dimension in die Asset-Antwort ein

Kehrt zurück:

Typ

Anlage

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.includeDimension();

setTags

Inklusive Tags in der Asset-Antwort

Kehrt zurück:

Typ

Anlage

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.setTags()

getTags

Enthält eine Reihe von Tags in der Vermögensantwort

Kehrt zurück:

Typ

String[]

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.getTags()

getDeletedBy

Wird vom Objekt aus der Asset-Antwort gelöscht

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.getDeletedBy()

getDeleteAt

Ruft das Objekt „Gelöscht am“ aus der Asset-Antwort ab

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken","environment");
Asset asset = stack.asset("assetUid");
asset.getDeleteAt()

getUpdatedBy

Ruft das UpdatedBy- Objekt aus der Asset-Antwort ab

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,"apiKey","deliveryToken", "environment");
Asset asset = stack.asset("assetUid");
asset.getUpdatedBy();

getUpdateAt

Ruft UpdateAt ab Objekt aus der Asset-Antwort

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getUpdateAt();
}
});

getCreatedBy

Ruft CreatedBy ab Objekt aus der Asset-Antwort

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getCreatedBy();
}
});

getCreateAt

Ruft CreateAt ab Objekt aus der Asset-Antwort

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getCreateAt();
}
});

toJSON

Ruft JSON ab Objekt aus der Asset-Antwort

Kehrt zurück:

Typ

JSONObject

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.toJSON();
}
});

getUrl

Ruft getUrl Objekt aus der Asset-Antwort

Kehrt zurück:

Typ

JSONObject

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.<span>getUrl()</span>;
}
});

getFileName

Ruft Dateinamen Objekt aus der Asset-Antwort

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.<span>getFileName()</span>;
}
});

getFileSize

Ruft Dateigröße Objekt aus der Asset-Antwort

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getFileSize();
}
});

getFileType

Ruft Dateityp Objekt aus der Asset-Antwort

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getFileType();
}
});

getAssetUid

Ruft AssetUid Objekt aus der Asset-Antwort

Kehrt zurück:

Typ

Zeichenfolge

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.fetch(new FetchResultCallback() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
 asset.getAssetUid();
}
});

RemoveHeader

Entfernt den Header mit der Taste

Kehrt zurück:

Typ

Leere

Name	Typ	Beschreibung
headerKey (erforderlich)	Zeichenfolge	Schlüssel des Headers, den Sie entfernen möchten

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Asset asset = stack.asset(assetUid);
asset.removeHeader(headerKey);

AssetLibrary

Sortieren

Asset-Bibliothek sortieren.

Kehrt zurück:

Typ

AssetLibrary

Name	Typ	Beschreibung
keyOrderBy (erforderlich)	Zeichenfolge	die Schlüsselreihenfolge nach
orderby (erforderlich)	SORTIEREN NACH	Das orderby kann mithilfe von ORDERBY-Enumerationen angewendet werden

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.sort(keyOrderBy, ORDERBY.ASCENDING);

includeCount

Zähl-Asset-Bibliothek einschließen.

Kehrt zurück:

Typ

AssetLibrary

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.includeCount();

includeRelativeUrl

Relative URL-Asset-Bibliothek einschließen.

Kehrt zurück:

Typ

AssetLibrary

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.includeRelativeUrl();

includeMetadata

Includes AssetLibrary metadata along with response body.

Kehrt zurück:

Typ

AssetLibrary

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", environment_name);
AssetLibrary assets = stack.assetLibrary();
assets.includeMetadata();

setHeader

Hinzufügen einen Header mit Schlüssel und Wert hinzu

Kehrt zurück:

Typ

AssetLibrary

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel, den Sie aus dem Header entfernen möchten
Wert (erforderlich)	Zeichenfolge	Wert des Headers gegenüber dem Schlüssel

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.setHeader(key, value);

RemoveHeader

Entfernt den Header-Schlüssel

Kehrt zurück:

Typ

AssetLibrary

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel, den Sie aus dem Header entfernen möchten

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.removeHeader(key);

includeFallback

Enthält die Fallback-Sprache

Kehrt zurück:

Typ

AssetLibrary

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.includeFallback()

getCount

Gibt eine Liste aller im Stapel verfügbaren Assets zurück

Kehrt zurück:

Typ

int

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.getCount()

setHeader

Holen Sie sich alle Vermögenswerte

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Rückruf (erforderlich)	FetchAssetsCallback	Der Rückruf vom Typ FetchAssetsCallback

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
AssetLibrary assets = stack.assetLibrary()
assets.fetchAll(new FetchAssetsCallback({

});

Wo

The where method retrieves assets from the stack using any field's UID associated with the assets.

Kehrt zurück:

Typ

AssetLibrary

Name	Typ	Beschreibung
field_name	Zeichenfolge	Enter the field UID of the asset
Wert	Zeichenfolge	Enter the value

Beispiel:

   import com.contentstack.sdk.*;
   Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
   AssetLibrary assets = stack.assetLibrary().where("field_name","value");
   assets.fetchAll(new FetchAssetsCallback(){
    @Override
    public void onCompletion(ResponseType responseType,List<Asset> assets,Error 
    error){ 
           System.out.println(assets);
          }});

Inhaltstyp

Der Inhalt definiert die Struktur oder das Schema einer Seite oder eines Abschnitts Ihres Web- oder mobilen Eigentums. Um Inhalte für Ihre Anwendung zu erstellen, müssen Sie zunächst einen Inhaltstyp erstellen und dann Einträge mithilfe des Inhaltstyps erstellen.

RemoveHeader

Entfernt den Header mithilfe von headerKey vom Stapel

Kehrt zurück:

Typ

Leere

Name	Typ	Beschreibung
headerKey (erforderlich)	Zeichenfolge	Die Schlüssel des Headers

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, apiKey, deliveryToken, environment);
ContentType contentType = stack.contentType("contentTypeUid");
contentType.removeHeader(headerKey)

Eintrag

Ein Eintrag ist der eigentliche Inhalt, der mit einem der definierten Inhaltstypen erstellt wurde.

Kehrt zurück:

Typ

Eintrag

Name	Typ	Beschreibung
Eintrags-ID (erforderlich)	Zeichenfolge	Die eindeutige Eintrags ID des Eintrags, den Sie abrufen möchten

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, apiKey, deliveryToken, environment);
ContentType contentType = stack.contentType("contentTypeUid");
contentType.entry("entryUid")

query

Stellt eine Abfrageinstanz bereit

Kehrt zurück:

Typ

Leere

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, apiKey, deliveryToken, environment);
ContentType contentType = stack.contentType("contentTypeUid");
contentType.query()

bringen

Ruft alle für den Stapel verfügbaren Inhaltstypen ab

Kehrt zurück:

Typ

Leere

Name	Typ	Beschreibung
Parameter (erforderlich)	JSONObject	Schlüsselwertparameter vom Typ JSONObject
Rückruf (erforderlich)	ContentTypesCallback	Der Rückruf vom Typ ContentTypesCallback

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context, apiKey, deliveryToken, environment);
ContentType contentType = stack.contentType("contentTypeUid");
contentType.fetch(new JSONObject(), new ContentTypesCallback() {
 @Override
public void onCompletion(ContentTypesModel model, Error error) {
   JSONArray resp = model.getResultArray();
}
});

Eintrag

Ein Eintrag ist der eigentliche Inhalt, der mit einem der definierten Inhaltstypen erstellt wurde.

außerWithReferenceUid()

Gibt ein Array von Ausnahmeschlüsseln an, die in der Antwort ausgeschlossen werden würden

Kehrt zurück:

Typ

Eintrag

Name	Typ	Beschreibung
fieldUid (erforderlich)	Anordnungsliste<String>	Array der Except-Referenzschlüssel, die als Antwort ausgeschlossen werden sollen
referenceFieldUid (erforderlich)	Zeichenfolge	Schlüssel, der auf ein anderes Klassenobjekt verweist

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.<span>exceptWithReferenceUid</span>()
ArrayList<String> array = new ArrayList<String>();
<span>array.add("description");</span>
<span>array.add("name");</span>
<span>entry.onlyWithReferenceUid(array, "referenceUid");</span>

onlyWithReferenceUid

Gibt ein Array nur der Schlüssel an, die in die Antwort einbezogen werden würden.

Kehrt zurück:

Typ

Eintrag

Name	Typ	Beschreibung
fieldUid (erforderlich)	Anordnungsliste<String>	Array der einzigen Referenzschlüssel, die in die Antwort einbezogen werden sollen.
referenceFieldUid (erforderlich)	Zeichenfolge	Schlüssel, der auf ein anderes Klassenobjekt verweist

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
ArrayList<String> array = new ArrayList<String>();
array.add("description");
array.add("name");
entry.onlyWithReferenceUid(array, "referenceUid");

only

Gibt ein Array nur von Schlüsseln im BASE-Objekt an, die in die Antwort eingeschlossen werden würden

Kehrt zurück:

Typ

Eintrag

Name	Typ	Beschreibung
fieldUid (erforderlich)	Anordnungsliste<String>	Array der einzigen Referenzschlüssel, die in die Antwort einbezogen werden sollen

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.only(new String[]{"name", "description"});

includeReference

Hinzufügen eine Einschränkung hinzu, die bestimmte Referenzschlüsseldetails erfordert.

Kehrt zurück:

Typ

Eintrag

Name	Typ	Beschreibung
referenceFields (erforderlich)	String[]	referenceFields-Array-Schlüssel, der eingeschränkt werden soll

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeReference(new String[]{"referenceUid_A", "referenceUid_B"});

außer

Gibt eine Liste von Feld-UIDs an, die von der Antwort ausgeschlossen würden

Kehrt zurück:

Typ

Eintrag

Name	Typ	Beschreibung
referenceField (erforderlich)	Zeichenfolge	Feld-UID, die von der Antwort ausgeschlossen werden.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.except(new String[]{"name", "description"});

setLocale

Legt das Gebietsschema des Eintrags fest

Kehrt zurück:

Typ

Eintrag

Name	Typ	Beschreibung
Gebietsschema (erforderlich)	Zeichenfolge	Sprachcode

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.setLocale();

getLocale

Ruft die Sprache des Eintrags ab

Kehrt zurück:

Typ

Eintrag

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.getLocale();

getUid

Ruft die Eintrags- UID ab

Kehrt zurück:

Typ

Eintrag

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.getUid()

getContentType

Ruft den Inhaltstyp des Eintrags ab

Kehrt zurück:

Typ

Eintrag

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.getContentType()

getTags

Ruft Eintrags -Tags ab

Kehrt zurück:

Typ

String[]

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.<span>getTags</span>()

RemoveHeader

Entfernt den Header mit der Taste

Kehrt zurück:

Typ

Leere

Name	Typ	Beschreibung
Taste	Zeichenfolge	Geben Sie den Schlüssel des Headers ein, den Sie entfernen möchten

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.removeHeader(key)

setHeader

Adds header using key and value

Kehrt zurück:

Typ

Leere

Name	Typ	Beschreibung
Taste	Zeichenfolge	Geben Sie den Schlüssel des Headers ein, den Sie entfernen möchten
Wert (erforderlich)	Zeichenfolge	value of the header against the key

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
Entry entry = entry.setHeader(key, value)

bringen

fetch wird verwendet, um die Eingabeantwort abzurufen

Kehrt zurück:

Typ

Leere

Name	Typ	Beschreibung
Rückruf (erforderlich)	EntryResultCallBack	EntryResultCallBack Einspruch dagegen einlegen, den Antrag zu benachrichtigen, wenn die Anfrage abgeschlossen ist

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.fetch(new EntryResultCallBack() {
@Override public void onCompletion(ResponseType responseType, Error error) {
}
});}

addParam

Fügt Abfrageparameter zur Eingabeanforderung hinzu

Kehrt zurück:

Typ

Eintrag

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Schlüssel des Headers
Wert (erforderlich)	Zeichenfolge	Wert des Headers

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.addParam(key, value)

includeReferenceContentTypeUID

Include Reference ContentType UID in the entry response

Kehrt zurück:

Typ

Eintrag

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeReferenceContentTypeUID()

includeContentType

Include ContentType in the entry response

Kehrt zurück:

Typ

Eintrag

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeContentType()

includeFallback

Beziehen Sie die Fallback- Sprache in die Eingabeantwort ein

Kehrt zurück:

Typ

Eintrag

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeFallback()

includeEmbeddedItems

Fügen Sie eingebettete Artikel in die Eingabeantwort ein

Kehrt zurück:

Typ

Eintrag

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("contentType").entry("entryUid");
entry.includeEmbeddedItems()

includeBranch

Fügen Sie den Zweig in die Eingabeantwort ein

Kehrt zurück:

Typ

Leere

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack.contentType("user").entry("entryUid");
entry.includeBranch();

includeMetadata

Includes Entry metadata along with response body.

Kehrt zurück:

Typ

Eintrag

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", environment_name);
Entry entry = stack.contentType("contentTypeUid").entry("entryUid");
entry.includeMetadata();

Varianten

The variants method retrieves details of a specific entry variant or an array of entry variants based on the applied query.

When Personalize creates a variant in the CMS, it assigns a "Variant Alias" to identify that specific variant. When fetching entry variants using the Delivery API, you can pass variant aliases in place of variant UIDs in the x-cs-variant-uid header.

Kehrt zurück:

Typ

Eintrag

Name	Typ	Beschreibung
variantUid/variantAlias (required)	String / String []	Enter the UID/Alias of the variant

Beispiel 1:

import com.contentstack.sdk.*;
Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack
                    .contentType("contentType")
                    .entry("entryUid")
                    .variants("variantUid/variantAlias");
 entry.fetch(new EntryResultCallBack() {
     @Override
     public void onCompletion(ResponseType responseType, Error error) {
              System.out.println(entry.toJSON());
         }
 });

Beispiel 2:

import com.contentstack.sdk.*;
Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
final Entry entry = stack
                    .contentType("contentType")
                    .entry("entryUid")
                    .variants(new String[]{"variantUid1/variantAlias1","variantUid2/variantAlias2"});
 entry.fetch(new EntryResultCallBack() {
     @Override
     public void onCompletion(ResponseType responseType, Error error) {
              System.out.println(entry.toJSON());
         }
 });

Query

Die Anforderung „Alle Einträge abrufen“ ruft die Liste aller Einträge eines bestimmten Inhaltstyps ab. Es gibt den Inhalt jedes Eintrags im JSON-Format zurück. Sie müssen die Umgebung und das Gebietsschema angeben, deren Einträge Sie erhalten möchten. Wir können auch Filter auf Abfragen anwenden.

RemoveHeader

Kopfschlüssel Entfernen

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Geben Sie den Schlüssel des Headers ein, den Sie entfernen möchten

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.removeHeader(key)

getContentType

Ruft den Inhaltstyp ab

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.getContentType()

Wo

Hinzufügen eine Einschränkung hinzu, um alle Einträge abzurufen, die einen bestimmten Wert für den angegebenen Schlüssel enthalten

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Schlüssel des Abfrageparameters
Wert (erforderlich)	Objekt	Wert des Abfrageparameters

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.where("uid", "entry_uid");

addQuery

Hinzufügen eine benutzerdefinierte Abfrage für den angegebenen Schlüssel hinzu.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Schlüssel des Abfrageparameters
Wert (erforderlich)	Zeichenfolge	Wert des Abfrageparameters

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.addQuery("key", "value");

RemoveQuery

Entfernen den bereitgestellten Abfrageschlüssel aus der benutzerdefinierten Abfrage, falls vorhanden.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Zu entfernender Abfragename.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.removeQuery(key);

oder

Kombiniert alle Abfragen mithilfe des UND-Operators

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
queryObjects (erforderlich)	Anordnungsliste<Query>	Liste der Abfrageinstanzen, auf denen die AND-Abfrage ausgeführt wird.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.lessThan("due_date", "2013-06-25T00:00:00+05:30");
Query query = projectClass.query();
query.where('username','something');
Query subQuery = projectClass.query();
subQuery.where('email_address','something@email.com');
ArrayList<Query> array = new ArrayList<Query>();
array.add(query);
array.add(subQuery);
query.and(array);

oder

Hinzufügen eine Einschränkung hinzu, um alle Einträge abzurufen, die alle Abfragen erfüllen.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
queryObjects (erforderlich)	Anordnungsliste<Query>	der Wert, der eine Obergrenze darstellt

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.lessThan("due_date", "2013-06-25T00:00:00+05:30");
Query query = projectClass.query();
query.where('username','something');
Query subQuery = projectClass.query();
subQuery.where('email_address','something@email.com');
ArrayList<Query> array = new ArrayList<Query>();
array.add(query);
array.add(subQuery);
query.or(array);

weniger als

Hinzufügen der Abfrage eine Einschränkung hinzu, die erfordert, dass ein bestimmter Schlüsseleintrag kleiner als der bereitgestellte Wert ist.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung
Werte (erforderlich)	Objekt	der Wert, der eine Obergrenze darstellt

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.lessThan("due_date", "2013-06-25T00:00:00+05:30");

Gleich oder kleiner als

AFügen Sie eine Einschränkung für die Abfrage hinzu, die erfordert, dass ein bestimmter Schlüsseleintrag kleiner oder gleich dem bereitgestellten Wert ist

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung
Werte (erforderlich)	Objekt	Der Wert, der gleich sein muss.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.lessThanOrEqualTo("due_date", "2013-06-25T00:00:00+05:30");

größer als

Hinzufügen der Abfrage eine Einschränkung hinzu, die erfordert, dass ein bestimmter Schlüsseleintrag größer als der bereitgestellte Wert ist.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung
Werte (erforderlich)	Objekt	Der Wert, der eine Untergrenze bereitstellt.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.greaterThan("due_date", "2013-06-25T00:00:00+05:30");

größer als oder gleich wie

Hinzufügen der Abfrage eine Einschränkung hinzu, die erfordert, dass ein bestimmter Schlüsseleintrag größer oder gleich dem bereitgestellten Wert ist.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung
Werte (erforderlich)	Objekt	Die Liste der Werte, die das Schlüsselobjekt nicht enthalten sollte.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.greaterThanOrEqualTo("due_date", "2013-06-25T00:00:00+05:30");

Nicht gleichzusetzen mit

Hinzufügen der Abfrage eine Einschränkung hinzu, die erfordert, dass der Eintrag eines bestimmten Schlüssels im bereitgestellten Array enthalten ist

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung
Werte (erforderlich)	Objekt	Die Liste der Werte, die das Schlüsselobjekt nicht enthalten sollte.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.notEqualTo("due_date", "2013-06-25T00:00:00+05:30");

notContainedIn

Hinzufügen der Abfrage eine Einschränkung hinzu, die erfordert, dass der Eintrag eines bestimmten Schlüssels im bereitgestellten Array enthalten ist

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung
Werte (erforderlich)	Objekt[]	Die Liste der Werte, die das Schlüsselobjekt nicht enthalten sollte.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.containedIn("severity", new Object[] { "Show Stopper", "Critical" });

notContainedIn

Hinzufügen der Abfrage eine Einschränkung hinzu, die erfordert, dass der Wert eines bestimmten Schlüsseleintrags nicht im bereitgestellten Array enthalten ist.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung
Werte (erforderlich)	Objekt[]	Die Liste der Werte, die das Schlüsselobjekt nicht enthalten sollte.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.notContainedIn("severity", new Object[] { "Show Stopper", "Critical" });

existiert

Hinzufügen eine Einschränkung hinzu, die erfordert, dass als Antwort ein angegebener Schlüssel vorhanden ist

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.exists("status");

existiert nicht

Hinzufügen als Antwort eine Einschränkung hinzu, die erfordert, dass ein angegebener Schlüssel nicht vorhanden ist.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.notExists("status");

includeReference

Hinzufügen eine Einschränkung hinzu, die bestimmte Referenzschlüsseldetails erfordert

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Schlüssel, der eingeschränkt werden soll

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeReference(key);

Stichworte

Fügen Sie Tags hinzu, mit denen nach Einträgen suchen werden soll

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	String[]	Durch Kommas getrenntes Array von Tags, mit denen nach Einträgen suchen werden soll.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.tags(new String[] { "tag1", "tag2" });

aufsteigend

Sortieren Sie die Ergebnisse in aufsteigender Reihenfolge mit dem angegebenen Schlüssel.<br> Sortieren Sie die zurückgegebenen Einträge in aufsteigender Reihenfolge des bereitgestellten Schlüssels.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zum Bestellen.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.ascending(key);

absteigend

Sortieren Sie die Ergebnisse in absteigender Reihenfolge mit dem angegebenen Schlüssel.<br> Sortieren Sie die zurückgegebenen Einträge in absteigender Reihenfolge des bereitgestellten Schlüssels.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zum Bestellen.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.descending(key);

only

Gibt ein Array nur von Schlüsseln im BASE-Objekt an, die in die Antwort einbezogen werden sollen.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
fieldUid (erforderlich)	String[]

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
<span>query.only(new String[]{"name"});</span>

außerWithReferenceUid

Gibt ein Array nur der Schlüssel an, die in die Antwort einbezogen werden würden

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
fieldUid (erforderlich)	Anordnungsliste<String>	Array der einzigen Referenzschlüssel, die in die Antwort einbezogen werden sollen
referenceFieldUid (erforderlich)	Zeichenfolge	Schlüssel, der auf ein anderes Klassenobjekt verweist

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
ArrayList<String> array = new ArrayList<String>();
array.add("description");
query.onlyWithReferenceUid(array, "for_bug");

außerWithReferenceUid

Gibt ein Array von Ausnahmeschlüsseln an, die in der Antwort ausgeschlossen würden.

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
ArrayList<String> array = new ArrayList<String>();
array.add("description");
query.exceptWithReferenceUid(array, "for_bug");

count

Anzahl und Daten der Objekte im Ergebnis abrufen

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.count();

includeCount

Anzahl und Daten der Objekte im Ergebnis abrufen

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeCount();

includeContentType

Schließen Sie den Inhalt aller zurückgegebenen Objekte zusammen mit den Objekten selbst ein

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeContentType();

includeOwner

Fügen Sie das Profil des Objektbesitzers in die Objektdaten ein.

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.<span>includeOwner</span>()

überspringen

Die Anzahl der Objekte, die übersprungen werden sollen, bevor eines zurückgegeben wird.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Nummer (erforderlich)	int	Anzahl der Objekte, die von den zurückgegebenen Objekten übersprungen werden sollen

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.skip(3)

Grenze

Eine Begrenzung der Anzahl der zurückzugebenden Objekte.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Nummer (erforderlich)	int	Anzahl der zu begrenzenden Objekte.

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
csQuery.limit(3)

Regex

Hinzufügen eine Einschränkung für reguläre Ausdrücke hinzu, um Zeichenfolgenwerte zu finden, die mit dem bereitgestellten regulären Ausdruck übereinstimmen. Dies kann bei großen Datensätzen langsam sein.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung.
Regex (erforderlich)	Zeichenfolge	Das zu vergleichende reguläre Ausdrucksmuster
Modifikatoren		Einer der folgenden unterstützten Modifikatoren für reguläre Ausdrücke. - Verwenden Sie i für den Vergleich ohne Berücksichtigung der Groß- und Kleinschreibung. - Verwenden Sie m, um Zeilenumbrüche mit Punktübereinstimmung zu erstellen. - Verwenden Sie x, um Leerzeichen in Regex zu ignorieren

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
csQuery.regex("name", "^browser", "i");

Gebietsschema

Legen Sie die Sprache mithilfe des Gebietsschemacodes fest.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Gebietsschema (erforderlich)	Zeichenfolge	Sprachcode

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.locale("locale-code");

suchen

Diese Methode stellt nur die Einträge bereit, die dem angegebenen Wert entsprechen.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Wert (erforderlich)	Zeichenfolge	Wert, der zum Abgleichen oder Vergleichen verwendet wird

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.search("header");

einen finden

Das Eine Abfrage ausführen und ihr Ergebnis zwischenspeichern (optional)

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Rückruf (erforderlich)	SingleQueryResultCallback	Der Schlüssel als String, der der Abfrage hinzugefügt werden muss

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.findOne(new QueryResultsCallBack() {
Override public void onCompletion(ResponseType responseType, ENTRY entry, Error error) {
}
});

addParam

Diese Methode fügt einem Eintrag Schlüssel und Wert hinzu. Parameter

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
paramKey (erforderlich)	Zeichenfolge	Der Schlüssel als String, der der Abfrage hinzugefügt werden muss
paramValue (erforderlich)	Zeichenfolge	Der Wert als Zeichenfolge, der der Abfrage hinzugefügt werden muss

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.addParam(key, value);

includeReferenceContentTypUid

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

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
csQuery.includeReferenceContentTypUid()

whereNotIn

Rufen Sie Einträge mit Werten ab, die auf referenzierten Feldern basieren. Diese Abfrage ruft alle Einträge ab, die die Abfragebedingungen für referenzierte Felder erfüllen.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung
queryObject (erforderlich)	Query	queryObject ist ein Abfrageobjekt, sodass Sie diesen Aufruf verketten können

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.whereIn("due_date", query);

whereNotIn

Rufen Sie Einträge mit Werten ab, die auf referenzierten Feldern basieren. Diese Abfrage funktioniert im Gegensatz zu $in_query und ruft alle Einträge ab, die die Abfragebedingungen für referenzierte Felder nicht erfüllen.

Kehrt zurück:

Typ

Query

Name	Typ	Beschreibung
Schlüssel (erforderlich)	Zeichenfolge	Der Schlüssel zur Einschränkung
queryObject (erforderlich)	Query	Abfrageobjekt, damit Sie diesen Aufruf verketten können

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.whereNotIn("due_date", query);

includeFallback

Beinhaltet einen Sprach-Fallback in der Abfrageantwort

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeFallback();

includeEmbeddedItems

Schließt eingebettete Artikel in die Abfrageantwort ein

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
query.includeEmbeddedItems();

includeBranch

Bezieht Branch in die Eingabeantwort ein

Kehrt zurück:

Typ

Query

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack(context,apiKey, deliveryToken, environment);
Query query = stack.contentType("contentTypeUid").query();
<span>entry.includeBranch();</span>

includeMetadata

Includes Query metadata along with the response body.

Kehrt zurück:

Typ

Query

Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", environment_name);
Query query = stack.contentType("contenTypeUid").query();
query.includeMetadata();

Taxonomie

Taxonomy helps you categorize pieces of content within your stack to facilitate easy navigation and retrieval of information.

Beispiel:

import com.contentstack.sdk.*;
Stack stack = Contentstack.stack(apiKey, deliveryToken, environment);
Taxonomy taxonomy = stack.taxonomy();

In

The in method retrieves all entries for a specific taxonomy that satisfy the given conditions provided in the $in query.

Kehrt zurück:

Typ

Instanz eines Taxonomieobjekts

Name	Typ	Beschreibung
taxonomy(required) (required)	Zeichenfolge	Geben Sie die UID der Taxonomie ein
Liste von Gegenständen	Liste<string>	Geben Sie die Liste der Taxonomiefelder ein

Beispiel:

Taxonomy taxonomy = stack.taxonomy();
List<string> listOfItems = new ArrayList<>();
listOfItems.add("maroon");
listOfItems.add("red");
taxonomy.in(taxonomy,listOfItems).find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

oder

The or method retrieves all entries for a specific taxonomy that satisfy at lease one of the given conditions provided in the $or query.

Kehrt zurück:

Typ

Instanz eines Taxonomieobjekts

Name	Typ	Beschreibung
Liste von Gegenständen	Liste<JSONObject>	Geben Sie die Liste der Taxonomiefelder ein

Beispiel:

Taxonomy taxonomy = stack.taxonomy();
List<jsonobject> listOfItems = new ArrayList<>();
JSONObject item1 = new JSONObject();
item1.put("taxonomies.color", "orange");
JSONObject item2 = new JSONObject();
item2.put("taxonomies.country", "zambia");
listOfItems.add(item1);
listOfItems.add(item2);
taxonomy.or(listOfItems).find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

und

The and method retrieves all entries for a specific taxonomy that satisfy all the given conditions provided in the $and query.

Kehrt zurück:

Typ

Instanz eines Taxonomieobjekts

Name	Typ	Beschreibung
Liste von Gegenständen	Liste<JSONObject>	Geben Sie die Liste der Taxonomiefelder ein

Beispiel:

Taxonomy taxonomy = stack.taxonomy();
List<JSONObject> listOfItems = new ArrayList<>();
JSONObject items1 = new JSONObject();
items1.put("taxonomies.color", "green");
JSONObject items2 = new JSONObject();
items2.put("taxonomies.country", "india");
listOfItems.add(items1);
listOfItems.add(items2);
taxonomy.and(listOfItems).find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

existiert

The exists method retrieves all entries for a specific taxonomy if the value of the field, mentioned in the condition, exists.

Kehrt zurück:

Typ

Instanz eines Taxonomieobjekts

Name	Typ	Beschreibung
Taxonomie (erforderlich)	Zeichenfolge	Geben Sie die UID der Taxonomie ein
Wert	Boolescher Wert	Geben Sie wahr/falsch ein

Beispiel:

Taxonomy taxonomy = stack.taxonomy().exists(taxonomy, Value);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

equalAndBelow

The equalAndBelow method retrieves all entries for a specific taxonomy that match a specific term and all its descendant terms, requiring only the target term.

Kehrt zurück:

Typ

Instanz eines Taxonomieobjekts

Name	Typ	Beschreibung
Taxonomie (erforderlich)	Zeichenfolge	Geben Sie die UID der Taxonomie ein
termsUid	Zeichenfolge	Geben Sie die UID des Begriffs ein

Beispiel:

Taxonomy taxonomy = stack.taxonomy().equalAndBelow(taxonomy, termsUid);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

unten

The below method retrieves all entries for a specific taxonomy that match all of their descendant terms by specifying only the target term and a specific level.

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

Kehrt zurück:

Typ

Instanz eines Taxonomieobjekts

Name	Typ	Beschreibung
Taxonomie (erforderlich)	Zeichenfolge	Geben Sie die UID der Taxonomie ein
termsUid	Zeichenfolge	Geben Sie die UID des Begriffs ein

Beispiel:

Taxonomy taxonomy = stack.taxonomy().below(taxonomy, termsUid);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

gleichOben

The equalAbove method retrieves all entries for a specific taxonomy that match a specific term and all its ancestor terms, requiring only the target term and a specified level.

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

Kehrt zurück:

Typ

Instanz eines Taxonomieobjekts

Name	Typ	Beschreibung
Taxonomie (erforderlich)	Zeichenfolge	Geben Sie die UID der Taxonomie ein
termsUid	Zeichenfolge	Geben Sie die UID des Begriffs ein

Beispiel:

Taxonomy taxonomy = stack.taxonomy().equalAbove(taxonomy, termsUid);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

über

The above method retrieves all entries for a specific taxonomy that match only the parent term(s) of a specified target term, excluding the target term itself and a specified level.

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

Kehrt zurück:

Typ

Instanz eines Taxonomieobjekts

Name	Typ	Beschreibung
Taxonomie (erforderlich)	Zeichenfolge	Geben Sie die UID der Taxonomie ein
termsUid	Zeichenfolge	Geben Sie die UID des Begriffs ein

Beispiel:

Taxonomy taxonomy = stack.taxonomy().above(taxonomy, termsUid);
taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("RESULT:",response.toString());
   }
});

finden

The find method is used to get API response.

Name	Typ	Beschreibung
callback	TaxonomyCallback	Die Rückrufklasse, die die API-Antwort enthält

Beispiel:

taxonomy.find(new TaxonomyCallback() {
   @Override
   public void onResponse(JSONObject response, Error error) {
       Log.d("Result:",response.toString());
   }
});

Contentstack Grundlagen

Schnellstart in 5 Minuten

Starter Apps

Lieferung von Inhalten APIs

Inhalt Management APIs

Anleitung Guides

Contentstack Grundlagen

Schnellstart in 5 Minuten

Starter Apps

Lieferung von Inhalten APIs

Inhalt Management APIs

Anleitung Guides

Contentstack - Android Delivery SDK

Android Delivery SDK for Contentstack

Voraussetzung

SDK-Installation und -Setup

Schnellstart in 5 Minuten

Initialisieren Sie Ihr SDK

Grundlegende Abfragen

Seitenzählung

Contentstack

Stapel

Konfig

setBranch

getBranch

setProxy

getProxy

getRegion

setRegion()

getHost()

setHost()

getVersion()

enableLivePreview()

setLivePreviewHost()

setManagementToken()

Früher Zugang

Anlage

bringen

includeBranch

includeFallback

includeMetadata

addParam

includeDimension

setTags

getTags

getDeletedBy

getDeleteAt

getUpdatedBy

getUpdateAt

getCreatedBy

getCreateAt

toJSON

getUrl

getFileName

getFileSize

getFileType

getAssetUid

RemoveHeader

AssetLibrary

Sortieren

includeCount

includeRelativeUrl

includeMetadata

setHeader

RemoveHeader

includeFallback

getCount

setHeader

Wo

Inhaltstyp

RemoveHeader

Eintrag

query

bringen

Eintrag

außerWithReferenceUid()

onlyWithReferenceUid

only

includeReference

außer

Contentstack
Grundlagen

Schnellstart
in 5 Minuten

Starter
Apps

Lieferung von Inhalten
APIs

Inhalt
Management APIs

Anleitung
Guides

Contentstack
Grundlagen

Schnellstart
in 5 Minuten

Starter
Apps

Lieferung von Inhalten
APIs

Inhalt
Management APIs

Anleitung
Guides