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

RxTalkApiClient

class RxTalkApiClient

카카오 Open API 의 카카오톡 API 호출을 담당하는 클라이언트. (for Reactive-X)

Constructors

<init>

카카오 Open API 의 카카오톡 API 호출을 담당하는 클라이언트. (for Reactive-X)

RxTalkApiClient(api: RxTalkApi = ApiFactory.rxKapiWithOAuth.create(RxTalkApi::class.java), apiInterceptor: TokenBasedApiInterceptor = TokenBasedApiInterceptor.instance)

Properties

apiInterceptor

val apiInterceptor: TokenBasedApiInterceptor

Functions

channels

사용자가 특정 카카오톡 채널을 추가했는지 확인합니다.

fun channels(publicIds: List<String>? = null): Single<ChannelRelations>

friends

카카오톡 친구 목록을 조회합니다.

fun friends(offset: Int? = null, limit: Int? = null, order: Order? = null, secureResource: Boolean? = true): Single<Friends<Friend>>

profile

로그인된 사용자의 카카오톡 프로필 정보를 얻을 수 있습니다.

fun profile(secureResource: Boolean? = true): Single<TalkProfile>

sendCustomMemo

개발자사이트에서 생성한 서비스만의 커스텀 메시지 템플릿을 사용하여, 카카오톡의 나와의 채팅방으로 메시지를 전송합니다. 템플릿을 생성하는 방법은 https://developers.kakao.com/docs/template 을 참고하시기 바랍니다.

fun sendCustomMemo(templateId: Long, templateArgs: Map<String, String>? = null): Completable

sendCustomMessage

개발자사이트에서 생성한 메시지 템플릿을 사용하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다. 템플릿을 생성하는 방법은 https://developers.kakao.com/docs/template 을 참고하시기 바랍니다.

fun sendCustomMessage(receiverUuids: List<String>, templateId: Long, templateArgs: Map<String, String>? = null): Single<MessageSendResult>

sendDefaultMemo

기본 템플릿을 이용하여, 카카오톡의 나와의 채팅방으로 메시지를 전송합니다.

fun sendDefaultMemo(templateParams: DefaultTemplate): Completable

sendDefaultMessage

기본 템플릿을 사용하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다.

fun sendDefaultMessage(receiverUuids: List<String>, templateParams: DefaultTemplate): Single<MessageSendResult>

sendScrapMemo

지정된 URL 을 스크랩하여, 카카오톡의 나와의 채팅방으로 메시지를 전송합니다.

fun sendScrapMemo(requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null): Completable

sendScrapMessage

지정된 URL을 스크랩하여, 조회한 친구를 대상으로 카카오톡으로 메시지를 전송합니다. 스크랩 커스텀 템플릿 가이드를 참고하여 템플릿을 직접 만들고 스크랩 메시지 전송에 이용할 수도 있습니다.

fun sendScrapMessage(receiverUuids: List<String>, requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null): Single<MessageSendResult>

Companion Object Properties

instance

val instance: RxTalkApiClient

Extension 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>>

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>