Photos Library/com.cloudike.sdk.photos.albums/Albums

Albums

interface Albums

Provides functionality for working with albums.

Types

AlbumsSorting

enum AlbumsSorting : Enum<Albums.AlbumsSorting>

ContentSorting

enum ContentSorting : Enum<Albums.ContentSorting>

ListingMode

enum ListingMode : Enum<Albums.ListingMode>

Functions

addMediaToAlbum

abstract suspend fun addMediaToAlbum(albumId: Long, mediaIds: Set<Long> = emptySet(), mediaUris: List<Uri> = emptyList()): AddMediaToAlbumResult

createAlbum

abstract suspend fun createAlbum(userId: Long, name: String, type: AlbumType, mediaIds: Set<Long> = emptySet(), mediaUris: List<Uri> = emptyList()): CreateAlbumResult

Creates an album.

createAlbumContentFlow

abstract fun createAlbumContentFlow(albumId: Long, sorting: Albums.ContentSorting = ContentSorting.CREATED_DESC): Flow<List<MediaItem>>

createAlbumContentPagingFlow

abstract fun createAlbumContentPagingFlow(albumId: Long, sorting: Albums.ContentSorting = ContentSorting.CREATED_DESC, config: PagingConfig = defaultPagingConfig): Flow<PagingData<MediaItem>>

createAlbumDatabaseSummaryFlow

abstract fun createAlbumDatabaseSummaryFlow(albumId: Long): Flow<AlbumDatabaseSummary>

createAlbumFlow

abstract fun createAlbumFlow(albumId: Long): Flow<AlbumItem?>

createAlbumsFlow

abstract fun createAlbumsFlow(userId: Long, albumTypes: Set<AlbumType> = setOf(AlbumType.SIMPLE, AlbumType.SHARED_BY_ME), minItemCount: Int = 0, isVisible: Boolean? = null, hideItems: Boolean? = null, limit: Int? = null, sorting: Albums.AlbumsSorting = AlbumsSorting.UPDATED_DESC, mode: Albums.ListingMode = ListingMode.INTERSECT): Flow<List<AlbumItem>>

createAlbumsPagingFlow

abstract fun createAlbumsPagingFlow(userId: Long, albumTypes: Set<AlbumType> = setOf(AlbumType.SIMPLE, AlbumType.SHARED_BY_ME), minItemCount: Int = 0, isVisible: Boolean? = null, hideItems: Boolean? = null, limit: Int? = null, sorting: Albums.AlbumsSorting = AlbumsSorting.UPDATED_DESC, mode: Albums.ListingMode = ListingMode.INTERSECT, config: PagingConfig = defaultPagingConfig): Flow<PagingData<AlbumItem>>

Creates Paging Flow for getting album list.

createMonthlySectionsGroupedByYearsFlow

abstract fun createMonthlySectionsGroupedByYearsFlow(albumId: Long): Flow<List<YearSectionInfo>>

deleteAlbum

abstract suspend fun deleteAlbum(albumId: Long)

Deleting album with albumId.

deleteMediaFromAlbum

abstract suspend fun deleteMediaFromAlbum(albumId: Long, mediaIds: Set<Long>): DeleteMediaFromAlbumResult

Deleting media with mediaIds from album with albumId. It only works with backend albums.

editAlbum

abstract suspend fun editAlbum(albumId: Long, type: AlbumType? = null, description: String? = null, isViewed: Boolean? = null, hideItems: Boolean? = null): AlbumItem

Edits an album with albumId.

fetchAlbumByBackendId

abstract suspend fun fetchAlbumByBackendId(userId: Long, albumBackendId: String, coversCount: Int? = null): AlbumItem?

fetchAlbumContent

abstract suspend fun fetchAlbumContent(albumId: Long)

fetchAlbums

abstract suspend fun fetchAlbums(userId: Long, types: Set<AlbumType>, coversCount: Int = 1)

getAlbum

abstract suspend fun getAlbum(albumId: Long): AlbumItem?

getAlbumByBackendId

abstract suspend fun getAlbumByBackendId(albumBackendId: String): AlbumItem?

getSectionAlbumPhotos

abstract suspend fun getSectionAlbumPhotos(albumId: Long, range: LongRange): List<MediaItem>

Return a list of PhotoItem from album, selected by time period(range)

getSharedLink

abstract suspend fun getSharedLink(albumId: Long): SharedLinkItem?

openSharedLink

abstract suspend fun openSharedLink(sharedLink: String, password: String?): AlbumItem

updateAlbumMeta

abstract suspend fun updateAlbumMeta(albumId: Long): AlbumItem