API - Shortform

숏폼 상세 재생

ShopLiveShortform.play(context: Context, requestData: ShopLiveShortformCollectionData? = null)를 통해 Shortform 상세화면을 재생합니다. (ShopLiveShortformCollectionData에 연관된 재생 목록)

• ShopLiveShortformCollectionData의 필드 값 중 하나 이상 넣으면 관련 상세화면을 재생할 수 있습니다.

• ShopLiveShortformCollectionData이 null이라면 전체 상세화면을 재생할 수 있습니다.

ShopLiveShortformCollectionData

숏폼 상세 View: 전체

ShopLiveShortform.play(context)

숏폼 상세 View: 목록 클릭 후 상세 재생

ShopLiveShortform.play(context, ShopLiveShortformCollectionData().apply {
    shortsId = "{CLICKED_IN_LIST_SHORTS_ID}"
})

숏폼 상세 View: 그룹 재생

ShopLiveShortform.play(context, ShopLiveShortformCollectionData().apply {
    shortsCollectionId = "{CLICKED_IN_LIST_SHORTS_COLLECTION_ID}"
})

숏폼 상세 View: 연관 태그 목록 클릭 후 재생

ShopLiveShortform.play(context, ShopLiveShortformCollectionData().apply {
    shortsId = "{CLICKED_IN_LIST_SHORTS_ID}"
    tags = "{CLICKED_IN_LIST_TAGS}"
    tagSearchOperator = "{CLICKED_IN_LIST_TAG_SEARCH_OPERATOR}"
})

숏폼 상세 View: 연관 브랜드 목록 클릭 후 재생

ShopLiveShortform.play(context, ShopLiveShortformCollectionData().apply {
    shortsId = "{CLICKED_IN_LIST_SHORTS_ID}"
    brands = "{CLICKED_IN_LIST_BRANDS}"
})

숏폼 상세 View: 연관 태그 재생

ShopLiveShortform.play(context, ShopLiveShortformCollectionData().apply {
    tags = "{YOUR_TAGS}"
    tagSearchOperator = "{YOUR_SEARCH_OPERATOR}"
})

숏폼 상세 View: 연관 브랜드 재생

ShopLiveShortform.play(context, ShopLiveShortformCollectionData().apply {
    brands = "{YOUR_BRANDS}"
})

숏폼 상세 Intent 구성

ShopLiveShortform.intent(context: Context, requestData: ShopLiveShortformCollectionData? = null)을 통해 Shortform 상세 화면을 재생할 수 있는 intent를 사용할 수 있습니다. (ShopLiveShortformCollectionData에 연관된 재생 목록)

• ShopLiveShortformCollectionData의 필드 값 중 하나 이상 넣으면 관련 상세화면을 재생할 수 있습니다.

• ShopLiveShortformCollectionData이 null이라면 전체 상세화면을 재생할 수 있습니다.

ShopLiveShortformCollectionData

숏폼 상세 View: 목록 클릭 후 상세 재생

val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
    shortsId = "{CLICKED_IN_LIST_SHORTS_ID}"
})
startActivity(intent)

숏폼 상세 View: 그룹 재생

val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
    shortsCollectionId = "{CLICKED_IN_LIST_SHORTS_COLLECTION_ID}"
})
startActivity(intent)

숏폼 상세 View: 연관 태그 목록 클릭 후 재생

val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
    shortsId = "{CLICKED_IN_LIST_SHORTS_ID}"
    tags = "{CLICKED_IN_LIST_TAGS}"
    tagSearchOperator = "{CLICKED_IN_LIST_TAG_SEARCH_OPERATOR}"
})
startActivity(intent)

숏폼 상세 View: 연관 브랜드 목록 클릭 후 재생

val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
    shortsId = "{CLICKED_IN_LIST_SHORTS_ID}"
    brands = "{CLICKED_IN_LIST_BRANDS}"
})
startActivity(intent)

숏폼 상세 View: 연관 태그 재생

val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
    tags = "{YOUR_TAGS}"
    tagSearchOperator = "{YOUR_SEARCH_OPERATOR}"
})
startActivity(intent)

숏폼 상세 View: 연관 브랜드 재생

val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
    brands = "{YOUR_BRANDS}"
})
startActivity(intent)

숏폼 상세 종료

숏폼 상세 뷰를 닫습니다.

ShopLiveShortform.close()

상세 화면 버튼 숨김처리

상세 화면의 버튼을 보여주게 할지 설정합니다.

ShopLiveShortformVisibleDetailTypeData

ShopLiveShortform.setVisibleDetailTypeViews(ShopLiveShortformVisibleDetailTypeData().apply {
    isLikeButtonVisible = true
    isCommentButtonVisible = true
    isShareButtonVisible = true
    isBookmarkVisible = true
})

숏폼 프리뷰 재생

ShopLiveShortform.showPreview(activity: Activity, data: ShopLiveShortformPreviewData)을 통해 Shortform 미리보기를 재생합니다. ( ShopLiveShortformRelatedData에 연관된 재생 목록 )

• ShopLiveShortformRelatedData의 필드 값 중 하나 이상 넣으면 관련 미리보기를 재생 할 수 있습니다.

ShopLiveShortformRelatedData

ShopLiveShortformPreviewData

숏폼 프리뷰: ProductId 기반

ShopLiveShortform.showPreview(activity: Activity, ShopLiveShortformRelatedData().apply {
    productId = "{PRODUCT_ID}"
})

숏폼 프리뷰: SKU 기반

ShopLiveShortform.showPreview(activity: Activity, ShopLiveShortformRelatedData().apply {
    sku = "{PRODUCT_SKU}"
})

숏폼 프리뷰: Tag 기반

ShopLiveShortform.showPreview(activity: Activity, ShopLiveShortformRelatedData().apply {
    tags = "{YOUR_TAGS}"
    tagSearchOperator = "{YOUR_SEARCH_OPERATOR}"
})

숏폼 프리뷰: Brand 기반

ShopLiveShortform.showPreview(activity: Activity, ShopLiveShortformRelatedData().apply {
    brands = "{YOUR_BRANDS}"
})

숏폼 프리뷰 종료

ShopLiveShortform.hidePreview()을 통해 현재 실행중인 숏폼 프리뷰를 닫습니다.

ShopLiveShortform.hidePreview()

특정 Shortform ID로 숏폼 상세 목록 구성

Coroutine 사용

ShopLiveShortform.play(context: Context, shortformIdsData: ShopLiveShortformIdsData, moreSuspendListener: ShopLiveShortformMoreSuspendListener)을 통해 숏폼 API로 받아온 shortformId를 이용해 playlist를 구성하고 순서대로 재생합니다.

ShopLiveShortformIdsData

ShopLiveShortformMoreSuspendListener

ShopLiveShortformIdsMoreData

ShopLiveShortform.play(context, ShopLiveShortformIdsData().apply {
    ids = "{YOUR_IDS}"
    currentId = "{YOUR_CURRENT_ID}"
}, ShopLiveShortformMoreSuspendListener {
    val moreResponse =
        kotlin.runCatching {
            "{YOUR_MORE_API_RESPONSE}"
        }.getOrNull() ?: return@ShopLiveShortformMoreSuspendListener null
    val ids = moreResponse.shortsList?.mapNotNull { it.shortsId } ?: emptyList()
    val hasMore = moreResponse.hasMore
    return@ShopLiveShortformMoreSuspendListener ShopLiveShortformIdsMoreData().apply {
        this.ids = ids
        this.hasMore = hasMore
    }
})

Future 사용

ShopLiveShortform.play(context: Context, shortformIdsData: ShopLiveShortformIdsData, moreFutureListener: ShopLiveShortformMoreFutureListener)을 통해 숏폼 API로 받아온 shortformId를 이용해 playlist를 구성하고 순서대로 재생합니다.

ShopLiveShortformIdsData

ShopLiveShortformMoreFutureListener

ShopLiveShortformIdsMoreData

ShopLiveShortform.play(context, ShopLiveShortformIdsData().apply {
    ids = "{YOUR_IDS}"
    currentId = "{YOUR_CURRENT_ID}"
}, ShopLiveShortformMoreFutureListener {
    val task: Future<ShopLiveShortformIdsMoreData?> =
        Executors.newCachedThreadPool().submit {
            "{YOUR_MORE_API_RESPONSE}"
            ShopLiveShortformIdsMoreData().apply {
                this.ids = ids
                this.hasMore = hasMore
            }
        }
    return@ShopLiveShortformMoreFutureListener task
})

ShopLiveShortform.get(context: Context, collectionData: ShopLiveShortformCollectionData? = null, callback: ShopLiveShortformCollectionListener)을 통해 Collection의 결과를 Callback형태로 확인할 수 있습니다.

응용하기

재사용이 가능한 RecyclerView에서 미리 Data를 받아 처리할 수 있습니다

ShopLiveShortformCollectionData

ShopLiveShortformCollectionListener

val data = ShopLiveShortformCollectionData()
ShopLiveShortform.get(context, data, object : ShopLiveShortformCollectionListener {
    // In background thread
    override fun onData(response: ShopLiveShortformCollectionResponse) {
        // Do something
    }
    override fun onError(e: Exception) {
        // Handle error
    }
})

setVisibleFullTypeViews()를 통해 숏폼 상세의 버튼 노출 여부를 설정합니다.

ShopLiveShortformVisibleFullTypeData

ShopLiveShortform.setVisibleFullTypeViews(ShopLiveShortformVisibleFullTypeData().apply {
    isLikeButtonVisible = true
    isCommentButtonVisible = true
    isShareButtonVisible = true
    isBookmarkVisible = true
})

ShopLiveShortform.setResizeMode(resizeMode: ShopLiveResizeMode)

ShopLiveShortform.connectBridgeInterface(activity, webView)

ShopLiveShortform.receiveBridgeInterface(webView)

webView.webViewClient = object : WebViewClient() {
    ...
    // Required
    override fun doUpdateVisitedHistory(view: WebView?, url: String?, isReload: Boolean) {
        super.doUpdateVisitedHistory(view, url, isReload)
        ShopLiveShortform.updateVisitedHistory(view, url, isReload)
    }
    ...
}