kakao-partner-android-sdk-rx / com.kakao.sdk.partner

Package com.kakao.sdk.partner

카카오 파트너들에게 제공되는 기능들이 있는 패키지.

Types

KakaoPhase

enum class KakaoPhase

Functions

chatList

카카오톡 채팅방 목록을 가져옵니다.

fun RxTalkApiClient.chatList(filters: List<ChatFilter>? = null, secureResource: Boolean? = true, offset: Int? = null, limit: Int? = null, order: Order? = null): Single<Chats>

chatMembers

사용자의 카카오톡 채팅방에 속한 멤버를 조회합니다. 채팅방 아이디를 기준으로 조회하며 친구인 멤버만 조회할지 여부를 선택할 수 있습니다.

fun RxTalkApiClient.chatMembers(chatId: Long, friendsOnly: Boolean? = null, includeProfile: Boolean? = null, secureResource: Boolean? = true, offset: Int? = null, limit: Int? = null, order: Order? = null): Single<ChatMembers>

friendsForPartner

fun RxTalkApiClient.friendsForPartner(friendType: FriendType? = null, friendFilter: FriendFilter? = null, friendOrder: FriendOrder? = null, secureResource: Boolean? = true, offset: Int? = null, limit: Int? = null, order: Order? = null): Single<Friends<PartnerFriend>>

init

fun KakaoSdk.init(context: Context, appKey: String, hosts: ServerHosts = PhasedServerHosts(KakaoPhase.PRODUCTION), loggingEnabled: Boolean = false): Unit

meForPartner

파트너용 /v2/user/me API 를 호출합니다. 사용자에 대한 다양한 정보를 얻을 수 있습니다.

fun RxUserApiClient.meForPartner(propertyKeys: List<String>? = null, secureReSource: Boolean = true): Single<PartnerUser>

sendCustomMessageForPartner

개발자사이트에서 생성한 메시지 템플릿을 사용하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다.

fun RxTalkApiClient.sendCustomMessageForPartner(receiverUuids: List<String>, templateId: Long, templateArgs: Map<String, String>? = null): Single<PartnerMessageSendResult>

sendCustomMessageToChats

개발자사이트에서 생성한 메시지 템플릿을 사용하여, 특정 채팅방에 카카오톡 메시지를 전송합니다.

fun RxTalkApiClient.sendCustomMessageToChats(receiverChatIds: List<Long>, templateId: Long, templateArgs: Map<String, String>? = null): Single<PartnerMessageSendResult>

sendDefaultMessageForPartner

기본 템플릿을 사용하여, 특정 채팅방에 카카오톡 메시지를 전송합니다.

fun RxTalkApiClient.sendDefaultMessageForPartner(receiverUuids: List<String>, templateParams: DefaultTemplate): Single<PartnerMessageSendResult>

sendDefaultMessageToChats

기본 템플릿을 사용하여, 특정 채팅방에 카카오톡 메시지를 전송합니다.

fun RxTalkApiClient.sendDefaultMessageToChats(receiverChatIds: List<Long>, templateParams: DefaultTemplate): Single<PartnerMessageSendResult>

sendScrapMessageForPartner

지정된 URL을 스크랩하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다.

fun RxTalkApiClient.sendScrapMessageForPartner(receiverUuids: List<String>, requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null): Single<PartnerMessageSendResult>

sendScrapMessageToChats

지정된 URL 을 스크랩하여, 특정 채팅방에 카카오톡 메시지를 전송합니다.

fun RxTalkApiClient.sendScrapMessageToChats(receiverChatIds: List<Long>, requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null): Single<PartnerMessageSendResult>

signup

앱 연결 상태가 PREREGISTER 상태의 사용자에 대하여 앱 연결 요청을 합니다. 자동연결 설정을 비활성화한 앱에서 사용합니다.

fun RxUserApiClient.signup(properties: Map<String, String>? = null): Completable

Companion Object Functions

withPhase

fun ServerHosts.Companion.withPhase(phase: KakaoPhase): ServerHosts