io.contentchef.callback.common.ContentChef.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of contentchef-jvm-callback-common Show documentation

ContentChef's JVM callback common SDK stuff - https://www.contentchef.io

There is a newer version: 1.3.0

Show newest version

package io.contentchef.callback.common

import io.contentchef.common.request.OnlineContentRequestData
import io.contentchef.common.request.PreviewContentRequestData
import io.contentchef.common.request.SearchOnlineRequestData
import io.contentchef.common.request.SearchPreviewRequestData

/**
 * Exposes methods used to retrieve contents from ContentChef's backend
 */
interface ContentChef {

    /**
     * Using the [PreviewChannel] you can retrieve contents which are in in both stage and live state and even contents that are not visible in the current date
     * [previewApiKey] is the api key required for the [PreviewChannel]
     * [publishingChannel] chosen publishingChannel
     */
    fun getPreviewChannel(previewApiKey: String, publishingChannel: String): PreviewChannel

    /**
     * Using the [OnlineChannel] you can retrieve contents which are in live state and which are actually visible
     * [onlineApiKey] is the api key required for the [OnlineChannel]
     * [publishingChannel] chosen publishingChannel
     */
    fun getOnlineChannel(onlineApiKey: String, publishingChannel: String): OnlineChannel

}

typealias PreviewChannel = Channel
typealias OnlineChannel = Channel