Asset

java.lang.Object
- com.contentstack.sdk.Asset

```
public class Asset
extends java.lang.Object
```
Asset class to fetch files details on Conentstack server.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`assetUid`
`protected java.lang.String`	`contentType`
`protected java.lang.String`	`fileName`
`protected java.lang.String`	`fileSize`
`protected android.util.ArrayMap<java.lang.String,java.lang.Object>`	`headerGroup_app`
`protected android.util.ArrayMap<java.lang.String,java.lang.Object>`	`headerGroup_local`
`protected org.json.JSONObject`	`json`
`protected Stack`	`stackInstance`
`protected java.lang.String[]`	`tagsArray`
`protected java.lang.String`	`uploadUrl`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Asset()

protected Asset(java.lang.String assetUid)

Constructors
Modifier	Constructor and Description
`protected`	`Asset()`
`protected`	`Asset(java.lang.String assetUid)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Asset`	`addParam(java.lang.String key, java.lang.String value)` This method adds key and value to an Entry.
`Asset`	`configure(org.json.JSONObject jsonObject)` Creates new instance of `Asset` from valid `JSONObject`.
`void`	`fetch(com.contentstack.sdk.FetchResultCallback callback)` Fetch a particular asset using uid.
`java.lang.String`	`getAssetUid()` Returns media file upload uid.
`java.util.Calendar`	`getCreateAt()` Get `Calendar` value of creation time of entry.
`java.lang.String`	`getCreatedBy()` Get uid who created this entry.
`java.util.Calendar`	`getDeleteAt()` Get `Calendar` value of deletion time of entry.
`java.lang.String`	`getDeletedBy()` Get uid who deleted this entry.
`java.lang.String`	`getFileName()` Returns file name of the uploaded file.
`java.lang.String`	`getFileSize()` Returns file queueSize of the uploaded file.
`java.lang.String`	`getFileType()` Returns content type of the uploaded file.
`java.lang.String[]`	`getTags()` Get tags.
`java.util.Calendar`	`getUpdateAt()` Get `Calendar` value of updating time of entry.
`java.lang.String`	`getUpdatedBy()` Get uid who updated this entry.
`java.lang.String`	`getUrl()` Returns upload url by which you can download media file uploaded on Built.io Contentstack server.
`Asset`	`includeDimension()` Include the dimensions (height and width) of the image in the response.
`Asset`	`includeFallback()` Retrieve the published content of the fallback locale if an entry is not localized in specified locale
`void`	`removeHeader(java.lang.String key)` Remove a header for a given key from headers.
`void`	`setCachePolicy(com.contentstack.sdk.CachePolicy cachePolicy)` To set cache policy using `Query` instance.
`void`	`setHeader(java.lang.String key, java.lang.String value)` To set headers for Built.io Contentstack rest calls.
`protected void`	`setStackInstance(Stack stack)`
`protected Asset`	`setTags(java.lang.String[] tags)` To set tags for this objects
`protected void`	`setUid(java.lang.String assetUid)` To set uid of media file which is uploaded on Built.io Contentstack server.
`org.json.JSONObject`	`toJSON()` Returns JSON representation of this `Asset` instance data.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

assetUid
```
protected java.lang.String assetUid
```

contentType
```
protected java.lang.String contentType
```

fileSize
```
protected java.lang.String fileSize
```

fileName
```
protected java.lang.String fileName
```

uploadUrl
```
protected java.lang.String uploadUrl
```

json
```
protected org.json.JSONObject json
```

tagsArray
```
protected java.lang.String[] tagsArray
```

headerGroup_app

protected android.util.ArrayMap<java.lang.String,java.lang.Object> headerGroup_app

headerGroup_local

protected android.util.ArrayMap<java.lang.String,java.lang.Object> headerGroup_local

stackInstance
```
protected Stack stackInstance
```

Constructor Detail

Asset
```
protected Asset()
```

Asset

protected Asset(java.lang.String assetUid)

Method Detail

setStackInstance

protected void setStackInstance(Stack stack)

configure

public Asset configure(org.json.JSONObject jsonObject)

Creates new instance of Asset from valid JSONObject. If JSON object is not appropriate then it will return null.

Parameters:

jsonObject - json object of particular file attached in the built object.
Asset can be generate using of data filled Entry and configure(JSONObject).

Example :

1. Single Attachment :-

    //'blt5d4sample2633b' is a dummy Application API key
    Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "bltdtsample_accessToken767vv",  config);

    Asset assetObject = stack.asset("assetUid");

    assetObject.configure(entryObject.getJSONObject(attached_image_field_uid));

2. Multiple Attachment :-

 JSONArray array = entryObject.getJSONArray(Attach_Image_Field_Uid);

    for (int i = 0; i < array.length(); i++) {

          Asset assetObject = stack.asset("assetUid");

          assetObject.configure(entryObject.getJSONObject(attached_image_field_uid));

    }

Returns:

Asset instance.

setHeader

public void setHeader(java.lang.String key,
                      java.lang.String value)

To set headers for Built.io Contentstack rest calls.
Scope is limited to this object only.

Parameters:

key - header name.

value - header value against given header name.

Example :

 //'blt5d4sample2633b' is a dummy Application API key
 Asset assetObject = Contentstack.stack(context, "blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).asset("assetUid");

 assetObject.setHeader("custom_header_key", "custom_header_value");

removeHeader

public void removeHeader(java.lang.String key)

Remove a header for a given key from headers.
Scope is limited to this object only.

Parameters:

key - header key.

Example :

 //'blt5d4sample2633b' is a dummy Application API key
 Asset assetObject = Contentstack.stack(context, "blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).asset("assetUid");

 assetObject.removeHeader("custom_header_key");

setUid

protected void setUid(java.lang.String assetUid)

To set uid of media file which is uploaded on Built.io Contentstack server.

Parameters:

assetUid - upload uid.

Example :

 //'blt5d4sample2633b' is a dummy Application API key
 Asset assetObject = Contentstack.stack(context, "blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).asset("assetUid");

 assetObject.setUid("upload_uid");

getAssetUid
```
public java.lang.String getAssetUid()
```
Returns media file upload uid. You will get uploaded uid after uploading media file on Built.io Contentstack server.

Example :
```
 String uid = assetObject.getAssetUid();
 
```

getFileType

public java.lang.String getFileType()

Returns content type of the uploaded file.

Example :

 String contentType = assetObject.getFileType();

getFileSize
```
public java.lang.String getFileSize()
```
Returns file queueSize of the uploaded file.

Note :
file size will receive in bytes number.

Example :
```
 String queueSize = assetObject.getFileSize();
 
```

getFileName

public java.lang.String getFileName()

Returns file name of the uploaded file.

Example :

 String fileName = assetObject.getFileName();

getUrl
```
public java.lang.String getUrl()
```
Returns upload url by which you can download media file uploaded on Built.io Contentstack server. You will get uploaded url after uploading media file on Built.io Contentstack server.

Example :
```
 String url = assetObject.getUrl();
 
```

toJSON

public org.json.JSONObject toJSON()

Returns JSON representation of this Asset instance data.

Example :

  JSONObject json = assetObject.toJSON();

getCreateAt

public java.util.Calendar getCreateAt()

Get Calendar value of creation time of entry.

Example :

 Calendar createdAt = assetObject.getCreateAt("key");

getCreatedBy

public java.lang.String getCreatedBy()

Get uid who created this entry.

Example :

 String createdBy_uid = assetObject.getCreatedBy();

getUpdateAt

public java.util.Calendar getUpdateAt()

Get Calendar value of updating time of entry.

Example :

 Calendar updatedAt = assetObject.getUpdateAt("key");

getUpdatedBy

public java.lang.String getUpdatedBy()

Get uid who updated this entry.

Example :

 String updatedBy_uid = assetObject.getUpdatedBy();

getDeleteAt

public java.util.Calendar getDeleteAt()

Get Calendar value of deletion time of entry.

Example :

 Calendar updatedAt = entry.getUpdateAt("key");

getDeletedBy

public java.lang.String getDeletedBy()

Get uid who deleted this entry.

Example :

 String deletedBy_uid = assetObject.getDeletedBy();

getTags

public java.lang.String[] getTags()

Get tags.

Example :

 String[] tags = assetObject.getURL();

setCachePolicy

public void setCachePolicy(com.contentstack.sdk.CachePolicy cachePolicy)

To set cache policy using Query instance.

Parameters:

cachePolicy - CachePolicy instance. Query object, so you can chain this call.

Example :

      //'blt5d4sample2633b' is a dummy Stack API key
      //'blt6d0240b5sample254090d' is dummy access token.
      Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
      Asset assetObject = stack.asset("bltsampleAsset");


      assetObject.setCachePolicy(NETWORK_ELSE_CACHE);

fetch

public void fetch(com.contentstack.sdk.FetchResultCallback callback)

Fetch a particular asset using uid.

Parameters:

callback - FetchResultCallback instance for success and failure result.

Example :

  Asset asset = stack.asset("blt5312f71416d6e2c8");
  asset.fetch(new FetchResultCallback() {
    @Override
    public void onCompletion(ResponseType responseType, Error error) {
          if(error == null){
            //Success Block.
          }else {
            //Fail Block.
          }
    }
  });

setTags

protected Asset setTags(java.lang.String[] tags)

To set tags for this objects

Parameters:

tags - array of tag.

Returns:

Asset object, so you can chain this call.

Example :

 //'blt5d4sample2633b' is a dummy Application API key
 Asset assetObject = Contentstack.stack(context, "blt5d4sample2633b", "bltdtsample_accessToken767vv",  config).asset("assetUid");
 assetObject.setTags(new String[]{"tag1", "tag2"});

addParam

public Asset addParam(java.lang.String key,
                      java.lang.String value)

This method adds key and value to an Entry.

Parameters:

key - The key as string which needs to be added to an Asset

value - The value as string which needs to be added to an Asset

Returns:

Asset

Example :

 final Asset asset = stack.asset("blt5312f71416d6e2c8");
 asset.addParam("key", "some_value");

  asset.fetch(new FetchResultCallback() {
    @Override
    public void onCompletion(ResponseType responseType, Error error) {
          if(error == null){
            //Success Block.
          }else {
            //Fail Block.
          }
    }
  });

includeDimension
```
public Asset includeDimension()
```
Include the dimensions (height and width) of the image in the response. Supported image types: JPG, GIF, PNG, WebP, BMP, TIFF, SVG, and PSD

Returns:

Asset

includeFallback

public Asset includeFallback()

Retrieve the published content of the fallback locale if an entry is not localized in specified locale

Returns:

Asset object, so you can chain this call.

Example :

     Stack stack = Contentstack.stack(context, "ApiKey", "deliveryToken", "environment");
     final Asset asset = stack.asset("asset_uid");
     asset.includeFallback();

Class Asset

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

assetUid

contentType

fileSize

fileName

uploadUrl

json

tagsArray

headerGroup_app

headerGroup_local

stackInstance

Constructor Detail

Asset

Asset

Method Detail

setStackInstance

configure

setHeader

removeHeader

setUid

getAssetUid

getFileType

getFileSize

getFileName

getUrl

toJSON

getCreateAt

getCreatedBy

getUpdateAt

getUpdatedBy

getDeleteAt

getDeletedBy

getTags

setCachePolicy

fetch

setTags

addParam

includeDimension

includeFallback