ArcXP-Mobile-SDK-Android/com.arcxp.content/ArcXPContentManager

ArcXPContentManager

This class is responsible for dispensing content.

Content source may be from api or db depending on repository

This class has a restricted constructor, so use the instance provided by com.arcxp.ArcXPMobileSDK method com.arcxp.ArcXPMobileSDK.contentManager after initializing com.arcxp.ArcXPMobileSDK.

Each request method can either use ArcXPContentCallback parameter for result stream or use the return value LiveData and subscribe to result stream.

Functions

clearCache

fun clearCache(): Job

clearCache removes all entries from database

deleteCollection

fun deleteCollection(collectionAlias: String): Job

deleteCollection

deleteItem

fun deleteItem(id: String): Job

deleteItem

getArcXPStory

fun getArcXPStory( id: String, listener: ArcXPContentCallback? = null, shouldIgnoreCache: Boolean = false): LiveData<Either<ArcXPException, ArcXPStory>>

getArcXPStory This function requests a story / article result by ANS ID

getArcXPStorySuspend

suspend fun getArcXPStorySuspend(id: String, shouldIgnoreCache: Boolean = false): Either<ArcXPException, ArcXPStory>

getArcXPStorySuspend This function requests a story / article result by ANS ID

getCollection

fun getCollection( collectionAlias: String, listener: ArcXPContentCallback? = null, shouldIgnoreCache: Boolean = false, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE, preLoading: Boolean? = null): LiveData<Either<ArcXPException, Map<Int, ArcXPContentElement>>>

This function requests a collection result by content alias

getCollectionAsJson

fun getCollectionAsJson( collectionAlias: String, listener: ArcXPContentCallback? = null, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE, preLoading: Boolean? = null): LiveData<Either<ArcXPException, String>>

This function requests a collection result by content alias as a json string

getCollectionAsJsonSuspend

suspend fun getCollectionAsJsonSuspend( collectionAlias: String, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE, shouldIgnoreCache: Boolean = false, preLoading: Boolean? = null): Either<ArcXPException, String>

getCollectionAsJsonSuspend - request collection by content alias Note this should be a troubleshooting function, does not use cache

getCollectionSuspend

suspend fun getCollectionSuspend( collectionAlias: String, shouldIgnoreCache: Boolean = false, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE, preLoading: Boolean? = null): Either<ArcXPException, Map<Int, ArcXPContentElement>>

getCollectionSuspend this suspend function requests a collection result by content alias

getContentAsJson

fun getContentAsJson( id: String, shouldIgnoreCache: Boolean = false, listener: ArcXPContentCallback? = null): LiveData<Either<ArcXPException, String>>

getContentAsJson This function requests a result by ANS ID as a json string

getContentAsJsonSuspend

suspend fun getContentAsJsonSuspend(id: String, shouldIgnoreCache: Boolean = false): Either<ArcXPException, String>

getContentAsJsonSuspend - request content element as JSON by ANS id Note this should be a troubleshooting function, does not use cache

getContentSuspend

suspend fun getContentSuspend(id: String, shouldIgnoreCache: Boolean = false): Either<ArcXPException, ArcXPContentElement>

getContentSuspend This suspend function requests an ans result by id

getGallery

fun getGallery( id: String, listener: ArcXPContentCallback? = null, shouldIgnoreCache: Boolean = false): LiveData<Either<ArcXPException, ArcXPContentElement>>

This function requests a gallery result by ANS ID

getSectionList

fun getSectionList( siteHierarchy: String, listener: ArcXPContentCallback? = null, shouldIgnoreCache: Boolean = false): LiveData<Either<ArcXPException, List<ArcXPSection>>>

This function requests list of section headers that are used for navigation It is expected these correlate with existing collections

getSectionListAsJson

fun getSectionListAsJson( siteHierarchy: String, listener: ArcXPContentCallback? = null, shouldIgnoreCache: Boolean = false): LiveData<Either<ArcXPException, String>>

This function requests list of section headers as a json string that are used for navigation It is expected these correlate with existing collections

getSectionListAsJsonSuspend

suspend fun getSectionListAsJsonSuspend(siteHierarchy: String, shouldIgnoreCache: Boolean = false): Either<ArcXPException, String>

getSectionListAsJsonSuspend - request section lists / navigation

getSectionListSuspend

suspend fun getSectionListSuspend(siteHierarchy: String, shouldIgnoreCache: Boolean = false): Either<ArcXPException, List<ArcXPSection>>

getSectionListSuspend This suspend function requests list of section headers that are used for navigation It is expected these results correlate with existing collections for subsequent requests

getVideo

~~fun~~ ~~getVideo~~( id: String, listener: ArcXPContentCallback? = null, shouldIgnoreCache: Boolean = false): LiveData<Either<ArcXPException, ArcXPContentElement>>

This function requests a video result by ANS ID

fun search( searchTerm: String, listener: ArcXPContentCallback? = null, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): LiveData<Either<ArcXPException, Map<Int, ArcXPContentElement>>>

fun search( searchTerms: List<String>, listener: ArcXPContentCallback? = null, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): LiveData<Either<ArcXPException, Map<Int, ArcXPContentElement>>>

This function requests a search to be performed by search Term (keyword/tag based on resolver setup default is tag(used in example app)) note: cache is not used for search, but if you open item it will be cached

searchAsJson

fun searchAsJson( searchTerm: String, listener: ArcXPContentCallback? = null, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): LiveData<Either<ArcXPException, String>>

fun searchAsJson( searchTerms: List<String>, listener: ArcXPContentCallback? = null, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): LiveData<Either<ArcXPException, String>>

searchAsJsonSuspend

suspend fun searchAsJsonSuspend( searchTerm: String, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): Either<ArcXPException, String>

searchAsJsonSuspendThis function requests a search to be performed by search Term (keyword/tag based on resolver setup default is tag(used in example app)) note: cache is not used for search, but if you open item it will be cached

suspend fun searchAsJsonSuspend( searchTerms: List<String>, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): Either<ArcXPException, String>

searchAsJsonSuspend this function requests a search to be performed by search Term (keyword/tag based on resolver setup default is tag(used in example app)) note: cache is not used for search, but if you open item it will be cached

searchSuspend

suspend fun searchSuspend( searchTerm: String, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): Either<ArcXPException, Map<Int, ArcXPContentElement>>

suspend fun searchSuspend( searchTerms: List<String>, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): Either<ArcXPException, Map<Int, ArcXPContentElement>>

searchSuspend requests a search to be performed by search Term (keyword/tag based on resolver setup default is tag(used in example app)) note: cache is not used for search, but if you open item it will be cached

searchVideos

fun searchVideos( searchTerm: String, listener: ArcXPContentCallback? = null, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): LiveData<Either<ArcXPException, Map<Int, ArcXPContentElement>>>

fun searchVideos( searchTerms: List<String>, listener: ArcXPContentCallback? = null, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): LiveData<Either<ArcXPException, Map<Int, ArcXPContentElement>>>

searchVideosSuspend

suspend fun searchVideosSuspend( searchTerm: String, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): Either<ArcXPException, Map<Int, ArcXPContentElement>>

searchVideosSuspend requests a search to be performed by search Term (keyword/tag based on resolver setup default is tag(used in example app))

suspend fun searchVideosSuspend( searchTerms: List<String>, from: Int = 0, size: Int = DEFAULT_PAGINATION_SIZE): Either<ArcXPException, Map<Int, ArcXPContentElement>>

searchVideosSuspend requests a search to be performed by search Term (keyword/tag based on resolver setup default is tag(used in example app)) note: cache is not used for search, but if you open item it will be cached

Properties

collectionLiveData

val collectionLiveData: LiveData<Either<ArcXPException, Map<Int, ArcXPContentElement>>>

collectionLiveData subscribe to this for ordered list of collection with their server index (WebSked order) in list as key (getCollection returns this additionally)

contentLiveData

val contentLiveData: LiveData<Either<ArcXPException, ArcXPContentElement>>

contentLiveData subscribe to this for generic content element results for search / section lists (getVideo, getGallery return this additionally)

jsonLiveData

val jsonLiveData: LiveData<Either<ArcXPException, String>>

jsonLiveData subscribe to this for all raw json results as string ( -AsJson methods return this additionally)

searchLiveData

val searchLiveData: LiveData<Either<ArcXPException, Map<Int, ArcXPContentElement>>>

searchLiveData subscribe to this for ordered list of collection with their server index (search result order) in list as key (search, searchVideo returns this additionally)

sectionListLiveData

val sectionListLiveData: LiveData<Either<ArcXPException, List<ArcXPSection>>>

sectionListLiveData subscribe to this for navigation list from server in list as key (getSectionList returns this additionally)

storyLiveData

val storyLiveData: LiveData<Either<ArcXPException, ArcXPStory>>

storyLiveData subscribe to this for story element results (getStory returns this additionally)