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 frontend, and Contentstack will take care of the rest. Read More.
Contentstack provides Android SDK to build application on top of Android. Given below is the detailed guide and helpful resources to get started with our Android SDK.
You will need one of the following: Android Studio or Eclipse.
To use the Contentstack Android SDK to your existing project, perform the steps given below:
- Gradle
implementation 'com.contentstack.sdk:android:{version}'- Maven
<dependency>
<groupId>com.contentstack.sdk</groupId>
<artifactId>android</artifactId>
<version>{version}</version>
</dependency>Download updated version from here
Or,
To add the Contentstack Android SDK to your existing project manually, perform the steps given below:
- Download the Android SDK and extract the ZIP file to your local disk.
- Add references/dependencies using Eclipse/Android Studio:
- Copy the 'Contentstack-x.x.x.jar' file into your project's libs folder.
- Add the dependency code into your 'build.gradle' file.
compile fileTree(dir: 'libs', include: ['*.jar'])
- Copy the 'Contentstack-x.x.x-javadoc' folder and the 'Contentstack-x.x.x.jar' and 'Contentstack-x.x.x.jar.properties' files into your project's 'libs' folder.
- Open the 'Properties' window of the project. Select the 'Java Build Path' option on the left-hand side menu, click on the 'Libraries' tab, and add the JAR references there.
- Configure 'AndroidManifest.xml' with permissions and receivers using the following code:
To initialize the SDK, specify application context, the API key, access token, and environment name of the stack as shown in the snippet given below:
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");Once you have initialized the SDK, you can query entries to fetch the required content.
A stack is like a container that holds the content of your app. Learn more about Stacks.
Content type lets you define the structure or blueprint of a page or a section of your digital property. It is a form-like page that gives Content Managers an interface to input and upload content. Read more.
An entry is the actual piece of content created using one of the defined content types. Learn more about Entries.
Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded to Contentstack. These files can be used in multiple entries. Read more about Assets.
A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published. Learn how to work with Environments.
To initialize the SDK, specify application context, the API key, access token, and environment name of the stack as shown in the snippet given below:
Stack stack = Contentstack.stack(context, "apiKey", "deliveryToken", "environment");Once you have initialized the SDK, you can query entries to fetch the required content.
To retrieve a single entry from a content type use the code snippet given below:
ContentType contentType = stack.contentType("contentTypeUid");Entry blogEntry = contentType.entry("entryUid");
blogEntry.fetch(new EntryResultCallBack() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
if (error == null) {
// Success block
} else {
// Error block
}}
});To retrieve multiple entries of a particular content type, use the code snippet given below:
//stack is an instance of Stack class
Query blogQuery = stack.contentType("contentTypeUid").query();
blogQuery.find(new QueryResultsCallBack() {
@Override
public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error) {
if(error == null){
//Success block
}else{
//Error block
}}
});You can query for content types, entries, assets and more using our Android API Reference.
We have introduced Image Delivery APIs that let you retrieve images and then manipulate and optimize them for your digital properties. It lets you perform a host of other actions such as crop, trim, resize, rotate, overlay, and so on.
For example, if you want to crop an image (with width as 300 and height as 400), you simply need to append query parameters at the end of the image URL, such as, https://images.contentstack.io/v3/assets/download?crop=300,400. There are several more parameters that you can use for your images.
Read Image Delivery API documentation.
// set the image quality to 100
LinkedHashMap imageParams = new LinkedHashMap();
imageParams.put("quality", 100);
imageUrl = Stack.ImageTransform(imageUrl, imageParams);
// resize the image by specifying width and height
LinkedHashMap imageParams = new LinkedHashMap();
imageParams.put("width", 100);
imageParams.put("height",100);
imageUrl = Stack.ImageTransform(imageUrl, imageParams);
// enable auto optimization for the image
LinkedHashMap imageParams = new LinkedHashMap();
imageParams.put("auto", "webp");
imageUrl = Stack.ImageTransform(imageUrl, imageParams);The Sync API takes care of syncing your Contentstack data with your app and ensures that the data is always up-to-date by providing delta updates. Contentstack’s Android SDK supports Sync API, which you can use to build powerful apps. Read through to understand how to use the Sync API with Contentstack Android SDK.
The Initial sync request performs a complete sync of your app data. It returns all the published entries and assets of the specified stack in response. To start the Initial sync process, use the syncInit method.
//stack is an instance of Stack class
stack.sync(new SyncResultCallBack() {
@Override
public void onCompletion(SyncStack syncStack,Error error) {
if(error == null){
//Success block
}else{
//Error block
}}
});If the result of the initial sync (or subsequent sync) contains more than 100 records, the response would be paginated. It provides pagination token in the response. However, you don’t have to use the pagination token manually to get the next batch; the SDK does that automatically until the sync is complete.
Pagination token can be used in case you want to fetch only selected batches. It is especially useful if the sync process is interrupted midway (due to network issues, etc.). In such cases, this token can be used to restart the sync process from where it was interrupted.
//stack is an instance of Stack class
stack.syncPaginationToken("paginationToken", new SyncResultCallBack() {
@Override
public void onCompletion(SyncStack syncStack, Error error) {
if(error == null){
//Success block
}else{
//Error block
}}
});You can use the sync token (that you receive after initial sync) to get the updated content next time. The sync token fetches only the content that was added after your last sync, and the details of the content that was deleted or updated.
//stack is an instance of Stack class
stack.syncToken("syncToken", new SyncResultCallBack() {
@Override
public void onCompletion(SyncStack syncStack,Error error) {
if(error == null){
//Success block
}else{
//Error block
}}
});You can use advanced sync queries to fetch custom results while performing initial sync. Read advanced sync queries documentation.
Copyright © 2012-2024 Contentstack. All Rights Reserved
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.