net.sitecore.android.sdk.api

Interface ScApiSession

public interface ScApiSession

Interface for interaction with Sitecore Item Web API. All requests to Sitecore Item Web API are built using instances of ScApiSession.

Method Summary

Methods

Modifier and Type	Method and Description
Request	checkCredentialsRequest(android.content.Context context, Response.Listener<java.lang.Boolean> callback) Creates request to read items from default path (/-/item/v1/) to check result code.
java.lang.String	createEncodedName() Creates encoded name for auth http header.
java.lang.String	createEncodedPassword() Creates encoded password for auth http header.
RequestBuilder	createItemRequest(java.lang.String branchId, Response.Listener<ItemsResponse> successListener, Response.ErrorListener errorListener) Creates RequestBuilder to build the CreateItemRequest
RequestBuilder	createItemRequest(java.lang.String itemName, java.lang.String template, Response.Listener<ItemsResponse> successListener, Response.ErrorListener errorListener) Creates RequestBuilder to build the CreateItemRequest
DeleteItemsRequest	deleteItem(ScItem item, Response.Listener<DeleteItemsResponse> successListener, Response.ErrorListener errorListener) Creates DeleteItemsRequest to delete item.
RequestBuilder	deleteItemsRequest(Response.Listener<DeleteItemsResponse> successListener, Response.ErrorListener errorListener) Creates RequestBuilder to build the DeleteItemsRequest.
EditItemsRequest	editItemFields(ScItem item, java.util.Map<java.lang.String,java.lang.String> fields, Response.Listener<ItemsResponse> successListener, Response.ErrorListener errorListener) Creates EditItemsRequest to update item fields.
RequestBuilder	editItemsRequest(Response.Listener<ItemsResponse> successListener, Response.ErrorListener errorListener) Creates RequestBuilder to build the EditItemsRequest.
java.lang.String	getBaseUrl()
ReadItemsRequest	getItemChildren(ScItem parentItem, Response.Listener<ItemsResponse> successListener, Response.ErrorListener errorListener) Creates ReadItemsRequest to retrieve children of specified ScItem.
java.lang.String	getMediaLibraryPath() Returns current media library path.
GetRenderingHtmlRequestBuilder	getRenderingHtmlRequest(java.lang.String renderingId, java.lang.String itemId, Response.Listener<java.lang.String> successListener, Response.ErrorListener errorListener) Creates GetRenderingHtmlRequestBuilder to build special request to load html rendering of an item.
boolean	isAnonymous()
RequestBuilder	readItemsByIdsRequest(java.util.ArrayList<java.lang.String> itemIds, Response.Listener<ItemsResponse> successListener, Response.ErrorListener errorListener) Creates ReadItemsRequest to load list of items with particular IDs.
RequestBuilder	readItemsRequest(Response.Listener<ItemsResponse> successListener, Response.ErrorListener errorListener) Creates RequestBuilder to build the ReadItemsRequest.
void	setDefaultDatabase(java.lang.String database) Specifies default database for requests.
void	setDefaultLanguage(java.lang.String language) Specifies default language for requests.
void	setDefaultSite(java.lang.String site) Specifies default site name for requests.
void	setMediaLibraryPath(java.lang.String path) Specifies media library path for uploading media.
void	setShouldCache(boolean shouldCache) Sets default caching value for all built requests.
boolean	shouldCache()
UploadMediaIntentBuilder	uploadMediaIntent(java.lang.String itemPath, java.lang.String itemName, java.lang.String mediaFilePath) Creates UploadMediaIntentBuilder that describe image upload request.

Method Detail

readItemsRequest

RequestBuilder readItemsRequest(Response.Listener<ItemsResponse> successListener,
                              Response.ErrorListener errorListener)

Creates RequestBuilder to build the ReadItemsRequest.

Parameters:

successListener - Success result callback.

errorListener - Error result callback

Returns:

RequestBuilder to build the request.

readItemsByIdsRequest

RequestBuilder readItemsByIdsRequest(java.util.ArrayList<java.lang.String> itemIds,
                                   Response.Listener<ItemsResponse> successListener,
                                   Response.ErrorListener errorListener)

Creates ReadItemsRequest to load list of items with particular IDs.

Parameters:

successListener - Success result callback.

errorListener - Error result callback

itemIds - specifies the ids of the items.

Returns:

ReadItemsRequest.

createItemRequest

RequestBuilder createItemRequest(java.lang.String itemName,
                               java.lang.String template,
                               Response.Listener<ItemsResponse> successListener,
                               Response.ErrorListener errorListener)

Creates RequestBuilder to build the CreateItemRequest

Parameters:

itemName - specifies the name of the item being created. It must be a valid Sitecore item name.

template - specifies the template that the new item is based on. It either accepts the template ID or the relative template path. For example, "Sample/MyTemplate"

successListener - Success result callback.

errorListener - Error result callback

Returns:

RequestBuilder to build the request.

createItemRequest

RequestBuilder createItemRequest(java.lang.String branchId,
                               Response.Listener<ItemsResponse> successListener,
                               Response.ErrorListener errorListener)

Creates RequestBuilder to build the CreateItemRequest

Parameters:

branchId - specifies the branch id that the new item is based on.

successListener - Success result callback.

errorListener - Error result callback

Returns:

RequestBuilder to build the request.

editItemsRequest

RequestBuilder editItemsRequest(Response.Listener<ItemsResponse> successListener,
                              Response.ErrorListener errorListener)

Creates RequestBuilder to build the EditItemsRequest.

Parameters:

successListener - Success result callback.

errorListener - Error result callback

Returns:

RequestBuilder to build the request.

deleteItemsRequest

RequestBuilder deleteItemsRequest(Response.Listener<DeleteItemsResponse> successListener,
                                Response.ErrorListener errorListener)

Creates RequestBuilder to build the DeleteItemsRequest.

Parameters:

successListener - Success result callback.

errorListener - Error result callback

Returns:

RequestBuilder to build the request.

checkCredentialsRequest

Request checkCredentialsRequest(android.content.Context context,
                              Response.Listener<java.lang.Boolean> callback)

Creates request to read items from default path (/-/item/v1/) to check result code.

Parameters:

context - current context.

callback - Is called after request is executed with true if request succeeded (200 <= code <= 300), and false otherwise.

getRenderingHtmlRequest

GetRenderingHtmlRequestBuilder getRenderingHtmlRequest(java.lang.String renderingId,
                                                     java.lang.String itemId,
                                                     Response.Listener<java.lang.String> successListener,
                                                     Response.ErrorListener errorListener)

Creates GetRenderingHtmlRequestBuilder to build special request to load html rendering of an item.

Parameters:

renderingId - Id of needed rendering item.

itemId - Id of needed data source item.

successListener - Success result callback.

errorListener - Error result callback

uploadMediaIntent

UploadMediaIntentBuilder uploadMediaIntent(java.lang.String itemPath,
                                         java.lang.String itemName,
                                         java.lang.String mediaFilePath)

Creates UploadMediaIntentBuilder that describe image upload request. Afterwards Context.startService(Intent)} should be used.

Parameters:

itemPath - Media folder path to upload media to.

itemName - Name of the media item.

mediaFilePath - any of "content://", "http://", "file://"

Returns:

UploadMediaIntentBuilder to build image upload intent.

deleteItem

DeleteItemsRequest deleteItem(ScItem item,
                            Response.Listener<DeleteItemsResponse> successListener,
                            Response.ErrorListener errorListener)

Creates DeleteItemsRequest to delete item. It will use default website if it's set in ScApiSession. To specify another website, use deleteItemsRequest(com.android.volley.Response.Listener<net.sitecore.android.sdk.api.model.DeleteItemsResponse>, com.android.volley.Response.ErrorListener).

Parameters:

successListener - Success result callback.

errorListener - Error result callback

item - ScItem to delete.

Returns:

DeleteItemsRequest to delete item.

See Also:

setDefaultSite(String), ScApiSession#deleteItemsRequest(Listener, ErrorListener)

getItemChildren

ReadItemsRequest getItemChildren(ScItem parentItem,
                               Response.Listener<ItemsResponse> successListener,
                               Response.ErrorListener errorListener)

Creates ReadItemsRequest to retrieve children of specified ScItem. It will use default website if it's set in ScApiSession. To specify another website, use ScApiSession#readItemsRequest(Listener, ErrorListener).

Parameters:

successListener - Success result callback.

errorListener - Error result callback.

parentItem - parent item who's children to retrieve.

Returns:

ReadItemsRequest to retrieve items.

See Also:

setDefaultSite(String), ScApiSession#readItemsRequest(Listener, ErrorListener)

editItemFields

EditItemsRequest editItemFields(ScItem item,
                              java.util.Map<java.lang.String,java.lang.String> fields,
                              Response.Listener<ItemsResponse> successListener,
                              Response.ErrorListener errorListener)

Creates EditItemsRequest to update item fields. It will use default website if it's set in ScApiSession. To specify another website, use ScApiSession#editItemsRequest(Listener, ErrorListener).

Parameters:

successListener - Success result callback.

errorListener - Error result callback

item - target ScItem who's fields to update.

fields - Map with ScField.getName() or ScField.getId() to String value entries

Returns:

EditItemsRequest to update item fields.

See Also:

setDefaultSite(String), ScApiSession#editItemsRequest(Listener, ErrorListener)

getBaseUrl

java.lang.String getBaseUrl()

Returns:

Backend url with port.

setDefaultSite

void setDefaultSite(java.lang.String site)

Specifies default site name for requests. This values is overridden by RequestBuilder.fromSite(String) method.

Parameters:

site - site name.

setDefaultLanguage

void setDefaultLanguage(java.lang.String language)

Specifies default language for requests. This values is overridden by RequestBuilder.setLanguage(String) method.

Parameters:

language - language.

setDefaultDatabase

void setDefaultDatabase(java.lang.String database)

Specifies default database for requests. This values is overridden by RequestBuilder.database(String) method.

Parameters:

database - database.

setMediaLibraryPath

void setMediaLibraryPath(java.lang.String path)

Specifies media library path for uploading media. If path is not set default media library path will be "/sitecore/media library".

Parameters:

path - media library path.

getMediaLibraryPath

java.lang.String getMediaLibraryPath()

Returns current media library path.

Returns:

media library path.

isAnonymous

boolean isAnonymous()

shouldCache

boolean shouldCache()

Returns:

true if requests should cache all responses. false by default.

setShouldCache

void setShouldCache(boolean shouldCache)

Sets default caching value for all built requests. Setting this value in request have higher priority.

createEncodedName

java.lang.String createEncodedName()

Creates encoded name for auth http header. Returns null when isAnonymous() is true;

createEncodedPassword

java.lang.String createEncodedPassword()

Creates encoded password for auth http header. Returns null when isAnonymous() is true;