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

TalkApiClient

class TalkApiClient

Constructors

<init>

TalkApiClient(talkApi: TalkApi = ApiFactory.kapiWithOAuth.create(TalkApi::class.java), applicationInfo: ApplicationInfo = KakaoSdk.applicationContextInfo, contextInfo: ContextInfo = KakaoSdk.applicationContextInfo)

Functions

addChannelUrl

카카오톡 채널을 추가하기 위한 URL 을 반환합니다. URL 을 브라우저나 웹뷰에서 로드하면 브릿지 웹페이지를 통해 카카오톡을 실행합니다.

fun addChannelUrl(channelPublicId: String): Uri

channelChatUrl

카카오톡 채널 1:1 대화방 실행을 위한 URL 을 반환합니다. URL 을 브라우저나 웹뷰에서 로드하면 브릿지 웹페이지를 통해 카카오톡을 실행합니다.

fun channelChatUrl(channelPublicId: String): Uri

channels

fun channels(publicIds: String? = null, callback: (relations: ChannelRelations?, error: Throwable?) -> Unit): Unit

friends

fun friends(secureResource: Boolean? = true, offset: Int? = null, limit: Int? = null, order: Order? = null, callback: (friends: Friends<Friend>?, error: Throwable?) -> Unit): Unit

profile

fun profile(secureResource: Boolean? = true, callback: (profile: TalkProfile?, error: Throwable?) -> Unit): Unit

sendCustomMemo

fun sendCustomMemo(templateId: Long, templateArgs: Map<String, String>? = null, callback: (error: Throwable?) -> Unit): Unit

sendCustomMessage

fun sendCustomMessage(receiverUuids: List<String>, templateId: Long, templateArgs: Map<String, String>? = null, callback: (result: MessageSendResult?, error: Throwable?) -> Unit): Unit

sendDefaultMemo

fun sendDefaultMemo(template: DefaultTemplate, callback: (error: Throwable?) -> Unit): Unit

sendDefaultMessage

fun sendDefaultMessage(receiverUuids: List<String>, template: DefaultTemplate, callback: (result: MessageSendResult?, error: Throwable?) -> Unit): Unit

sendScrapMemo

fun sendScrapMemo(requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null, callback: (error: Throwable?) -> Unit): Unit

sendScrapMessage

fun sendScrapMessage(receiverUuids: List<String>, requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null, callback: (result: MessageSendResult?, error: Throwable?) -> Unit): Unit

Companion Object Properties

instance

val instance: TalkApiClient

Extension Functions

chatList

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

fun TalkApiClient.chatList(filters: List<ChatFilter>? = null, offset: Int? = null, limit: Int? = null, order: Order? = null, secureResource: Boolean? = true, callback: (chats: Chats?, error: Throwable?) -> Unit): Unit

chatMembers

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

fun TalkApiClient.chatMembers(chatId: Long, friendsOnly: Boolean? = null, includeProfile: Boolean? = null, secureResource: Boolean? = true, offset: Int? = null, limit: Int? = null, order: Order? = null, callback: (chatMembers: ChatMembers?, error: Throwable?) -> Unit): Unit

friendsForPartner

fun TalkApiClient.friendsForPartner(friendType: FriendType? = null, friendFilter: FriendFilter? = null, friendOrder: FriendOrder? = null, secureResource: Boolean? = true, offset: Int? = null, limit: Int? = null, order: Order? = null, callback: (friends: Friends<PartnerFriend>?, error: Throwable?) -> Unit): Unit

sendCustomMessageForPartner

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

fun TalkApiClient.sendCustomMessageForPartner(receiverUuids: List<String>, templateId: Long, templateArgs: Map<String, String>? = null, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit

sendCustomMessageToChats

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

fun TalkApiClient.sendCustomMessageToChats(receiverChatIds: List<Long>, templateId: Long, templateArgs: Map<String, String>? = null, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit

sendDefaultMessageForPartner

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

fun TalkApiClient.sendDefaultMessageForPartner(receiverUuids: List<String>, template: DefaultTemplate, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit

sendDefaultMessageToChats

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

fun TalkApiClient.sendDefaultMessageToChats(receiverChatIds: List<Long>, template: DefaultTemplate, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit

sendScrapMessageForPartner

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

fun TalkApiClient.sendScrapMessageForPartner(receiverUuids: List<String>, requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit

sendScrapMessageToChats

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

fun TalkApiClient.sendScrapMessageToChats(receiverChatIds: List<Long>, requestUrl: String, templateId: Long? = null, templateArgs: Map<String, String>? = null, callback: (messageSendResult: PartnerMessageSendResult?, error: Throwable?) -> Unit): Unit

Companion Object Extension Properties

rx

카카오톡

val TalkApiClient.Companion.rx: RxTalkApiClient