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

RxTalkApiClient

class RxTalkApiClient

카카오 Open API 의 카카오톡 API 호출을 담당하는 클래스입니다.

Author
kevin.kang. Created on 2018. 3. 30..

Constructors

<init>

카카오 Open API 의 카카오톡 API 호출을 담당하는 클래스입니다.

RxTalkApiClient(api: RxTalkApi = ApiFactory.kapiWithOAuth.create(RxTalkApi::class.java), apiInterceptor: TokenBasedApiInterceptor = TokenBasedApiInterceptor.instance, applicationInfo: ApplicationInfo = KakaoSdk.applicationContextInfo, contextInfo: ContextInfo = KakaoSdk.applicationContextInfo)

Properties

apiInterceptor

val apiInterceptor: TokenBasedApiInterceptor

Functions

addFriendUrl

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

fun addFriendUrl(plusFriendId: String): Uri

chatUrl

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

fun chatUrl(plusFriendId: String): Uri

friends

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

plusFriends

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

fun plusFriends(publicIds: List<String>? = null): Single<PlusFriendsRelations>

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