com.kakao.kakaolink.v2

Class KakaoLinkService

java.lang.Object

com.kakao.kakaolink.v2.KakaoLinkService

public class KakaoLinkService
extends Object

Class for sending KakaoTalk messages using KakaoLink v2 API.

카카오링크 v2를 사용하기 위한 클래스.

Method Summary

Modifier and Type	Method and Description
void	deleteImageWithToken(android.content.Context context, String imageToken, ResponseCallback<com.kakao.network.storage.ImageDeleteResponse> callback) Delete the image with the given token from Kakao storage server.
static KakaoLinkService	getInstance() Returns a singleton instance for KakaoLink v2 API.
android.content.Intent	getKakaoTalkInstallIntent(android.content.Context context) Returns an intent to start KakaoTalk install page of Google play store.
boolean	isKakaoLinkV2Available(android.content.Context context)
void	scrapImage(android.content.Context context, Boolean secureResource, String imageUrl, ResponseCallback<com.kakao.network.storage.ImageUploadResponse> callback) Upload image with the given URL to Kakao storage server.
void	sendCustom(android.content.Context context, String templateId, Map<String,String> templateArgs, Map<String,String> serverCallbackArgs, ResponseCallback<KakaoLinkResponse> callback) Send KakaoLink v2 message with custom templates.
void	sendCustom(android.content.Context context, String templateId, Map<String,String> templateArgs, ResponseCallback<KakaoLinkResponse> callback) Send KakaoLink v2 message with custom templates.
void	sendDefault(android.content.Context context, TemplateParams params, Map<String,String> serverCallbackArgs, ResponseCallback<KakaoLinkResponse> callback) Send KakaoLink v2 message with default templates.
void	sendDefault(android.content.Context context, TemplateParams params, ResponseCallback<KakaoLinkResponse> callback) Send KakaoLink v2 message with default templates.
void	sendScrap(android.content.Context context, String url, Map<String,String> serverCallbackArgs, ResponseCallback<KakaoLinkResponse> callback) Send a URL scrap message with default scrap template.
void	sendScrap(android.content.Context context, String url, ResponseCallback<KakaoLinkResponse> callback) Send a URL scrap message with default scrap template.
void	sendScrap(android.content.Context context, String url, String templateId, Map<String,String> templateArgs, Map<String,String> serverCallbackArgs, ResponseCallback<KakaoLinkResponse> callback) Send a URL scrap message with custom template and template arguments.
void	sendScrap(android.content.Context context, String url, String templateId, Map<String,String> templateArgs, ResponseCallback<KakaoLinkResponse> callback) Send a URL scrap message with custom template and template arguments.
void	uploadImage(android.content.Context context, Boolean secureResource, File imageFile, ResponseCallback<com.kakao.network.storage.ImageUploadResponse> callback) Upload image to Kakao storage server to be used in KakaoLink message.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

deleteImageWithToken

public void deleteImageWithToken(android.content.Context context,
                                 String imageToken,
                                 ResponseCallback<com.kakao.network.storage.ImageDeleteResponse> callback)

Delete the image with the given token from Kakao storage server.

Parameters:

context - Context to start an activity for KakaoLink

imageToken - Token of image to be deleted

callback - success/failure callback that will be passed detailed warnings or error messages

getInstance

public static KakaoLinkService getInstance()

Returns a singleton instance for KakaoLink v2 API. 이 클래스의 싱글턴 인스턴스를 리턴한다.

Returns:

a singleton instance of KakaoLinkService class

getKakaoTalkInstallIntent

public android.content.Intent getKakaoTalkInstallIntent(android.content.Context context)

Returns an intent to start KakaoTalk install page of Google play store.

Parameters:

context - Context to get app information (package name, app key, key hash, and KA header) from.

Returns:

Intent to start KakaoTalk install page of Google Play Store.

isKakaoLinkV2Available

public boolean isKakaoLinkV2Available(android.content.Context context)

scrapImage

public void scrapImage(android.content.Context context,
                       Boolean secureResource,
                       String imageUrl,
                       ResponseCallback<com.kakao.network.storage.ImageUploadResponse> callback)

Upload image with the given URL to Kakao storage server.

Parameters:

context - Context to start an activity for KakaoLink

secureResource - true if https is needed for image url, false if http is sufficient

imageUrl - URL of image to be scrapped

callback - success/failure callback that will be passed detailed warnings or error messages

sendCustom

public void sendCustom(android.content.Context context,
                       String templateId,
                       Map<String,String> templateArgs,
                       Map<String,String> serverCallbackArgs,
                       ResponseCallback<KakaoLinkResponse> callback)

Send KakaoLink v2 message with custom templates. Template id and arguments should be provided.

커스텀 템플릿을 사용하여 카카오링크 v2 메시지를 보냄. 서버 콜백에 넘길 값들을 지정할 수 있다.

Parameters:

context - Context to start an activity for KakaoLink

templateId - id of the custom template created in developer website

templateArgs - template arguments to fill in the custom template

serverCallbackArgs - arguments for server callback

callback - success/failure callback that will contain detailed warnings or error messages

Throws:

IllegalStateException - if kakao app key or android key hash is not set

Since:

1.13.0

sendCustom

public void sendCustom(android.content.Context context,
                       String templateId,
                       Map<String,String> templateArgs,
                       ResponseCallback<KakaoLinkResponse> callback)

Send KakaoLink v2 message with custom templates. Template id and arguments should be provided.

커스텀 템플릿을 사용하여 카카오링크 v2 메시지를 보냄.

Parameters:

context - Context to start an activity for KakaoLink

templateId - id of the custom template created in developer website

templateArgs - template arguments to fill in the custom template

callback - success/failure callback that will contain detailed warnings or error messages

Throws:

IllegalStateException - if kakao app key or android key hash is not set

sendDefault

public void sendDefault(android.content.Context context,
                        TemplateParams params,
                        Map<String,String> serverCallbackArgs,
                        ResponseCallback<KakaoLinkResponse> callback)

Send KakaoLink v2 message with default templates.

디폴트 템플릿을 사용하여 카카오링크 v2 메시지를 보낸다. 별도의 템플릿 설정이 필요 없으며 아래의 템플릿 타입들을 지원한다.

- FeedTemplate - ListTemplate - LocationTemplate - CommerceTemplate - TextTemplate

Parameters:

context - Context to start an activity for KakaoLink

params - TemplateParams object containing template arguments bulit with its builder

serverCallbackArgs - arguments to be delivered to server callback

callback - success/failure callback that will contain detailed warnings or error messages

Throws:

IllegalStateException - if kakao app key or android key hash is not set

Since:

1.13.0

sendDefault

public void sendDefault(android.content.Context context,
                        TemplateParams params,
                        ResponseCallback<KakaoLinkResponse> callback)

Send KakaoLink v2 message with default templates.

디폴트 템플릿을 사용하여 카카오링크 v2 메시지를 보낸다. 별도의 템플릿 설정이 필요 없으며 아래의 템플릿 타입들을 지원한다.

- FeedTemplate - ListTemplate - LocationTemplate - CommerceTemplate - TextTemplate

Parameters:

context - Context to start an activity for KakaoLink

params - TemplateParams object containing template arguments bulit with its builder

callback - success/failure callback that will contain detailed warnings or error messages

Throws:

IllegalStateException - if kakao app key or android key hash is not set

sendScrap

public void sendScrap(android.content.Context context,
                      String url,
                      Map<String,String> serverCallbackArgs,
                      ResponseCallback<KakaoLinkResponse> callback)

Send a URL scrap message with default scrap template.

별도의 템플릿 설정 없이 카카오링크 v2 스크랩 메시지를 보낸다. 서버 콜백에 넘길 값들을 지정할 수 있다.

Parameters:

context - Context to start an activity for KakaoLink

url - URL to be scrapped

callback - success/failure callback that will be passed detailed warnings or error messages

serverCallbackArgs - arguments to be delivered to server callback

Throws:

IllegalStateException - if kakao app key or android key hash is not set

Since:

1.13.0

sendScrap

public void sendScrap(android.content.Context context,
                      String url,
                      ResponseCallback<KakaoLinkResponse> callback)

Send a URL scrap message with default scrap template.

별도의 템플릿 설정 없이 URL 스크랩 메시지를 보낸다.

Parameters:

context - Context to start an activity for KakaoLink

url - URL to be scrapped

callback - success/failure callback that will be passed detailed warnings or error messages

Throws:

IllegalStateException - if kakao app key or android key hash is not set

sendScrap

public void sendScrap(android.content.Context context,
                      String url,
                      String templateId,
                      Map<String,String> templateArgs,
                      Map<String,String> serverCallbackArgs,
                      ResponseCallback<KakaoLinkResponse> callback)

Send a URL scrap message with custom template and template arguments.

Parameters:

context - Context to start an activity for KakaoLink

url - URL to be scrapped

templateId - id of the custom template created in developer website

templateArgs - template arguments to fill in the custom template

serverCallbackArgs - arguments to be delivered to server callback

callback - success/failure callback that will be passed detailed warnings or error messages

Throws:

IllegalStateException - if kakao app key or android key hash is not set

Since:

1.13.0

sendScrap

public void sendScrap(android.content.Context context,
                      String url,
                      String templateId,
                      Map<String,String> templateArgs,
                      ResponseCallback<KakaoLinkResponse> callback)

Send a URL scrap message with custom template and template arguments.

Parameters:

context - Context to start an activity for KakaoLink

url - URL to be scrapped

templateId - id of the custom template created in developer website

templateArgs - template arguments to fill in the custom template

callback - success/failure callback that will be passed detailed warnings or error messages

Throws:

IllegalStateException - if kakao app key or android key hash is not set

uploadImage

public void uploadImage(android.content.Context context,
                        Boolean secureResource,
                        File imageFile,
                        ResponseCallback<com.kakao.network.storage.ImageUploadResponse> callback)

Upload image to Kakao storage server to be used in KakaoLink message.

자체적인 이미지 서버를 거치지 않고 로컬 디바이스에 있는 이미지를 카카오링크에 사용하고 싶은 경우 카카오 이미지 서버에 업로드 하는 기능.

Parameters:

context - Context to start an activity for KakaoLink

secureResource - true if https is needed for image url, false if http is sufficient

imageFile - Image file

callback - success/failure callback that will be passed detailed warnings or error messages