Share

Kakao. Namespace

Share

Description:

  • 카카오톡 공유 API 모듈
    Module for the Kakao Talk Sharing APIs

Methods

(static) cleanup()

Description:

  • 사용한 카카오톡 공유 모듈 리소스 해제
    Cleans up used Kakao Talk Sharing module resources

(static) createCustomButton(settings)

Description:

  • 사용자 정의 템플릿으로 메시지 보내기 버튼 생성
    Creates a button to send message with custom template

See:
Parameters:
Name Type Description
settings Object
Properties
Name Type Attributes Default Description
container String | HTMLElement

DOM Element 또는 Element의 ID Selector
ID Selector for DOM Element or Element
templateId Number

사용자 정의 템플릿 ID
Custom template ID
templateArgs Object <optional>

사용자 인자 키와 값
Keys and values of the user argument
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

(static) createDefaultButton(settings)

Description:

  • 기본 템플릿으로 메시지 보내기 버튼 생성
    Creates a button to send message with default template

Parameters:
Name Type Description
settings DefaultFeedSettings | DefaultListSettings | DefaultLocationSettings | DefaultCommerceSettings | DefaultTextSettings | DefaultCalendarSettings
Properties
Name Type Description
container String | HTMLElement

DOM Element 또는 Element의 ID Selector
ID Selector for DOM Element or Element

(static) createScrapButton(settings)

Description:

  • 스크랩 메시지 보내기 버튼 생성
    Creates a button to send scrape message

See:
Parameters:
Name Type Description
settings Object
Properties
Name Type Attributes Default Description
container String | HTMLElement

DOM Element 또는 Element의 ID Selector
ID Selector for DOM Element or Element
requestUrl String

스크랩할 URL
URL to scrape
templateId Number

사용자 정의 템플릿 ID
Custom template ID
templateArgs Object <optional>

사용자 인자 키와 값
Keys and values of the user argument
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

(static) deleteImage(settings) → {Promise}

Description:

  • 이미지 삭제하기
    Delete image

Parameters:
Name Type Description
settings Object
Properties
Name Type Description
imageUrl String

이미지 URL
Image URL
Returns:
Type
Promise

(static) scrapImage(settings) → {Promise.<ImageInfos>}

Description:

  • 이미지 스크랩하기
    Scrape image

Parameters:
Name Type Description
settings Object
Properties
Name Type Description
imageUrl String

이미지 URL
Image URL
Returns:
Type
Promise.<ImageInfos>

(static) sendCustom(settings)

Description:

  • 사용자 정의 템플릿으로 메시지 보내기
    Send message with custom template

See:
Parameters:
Name Type Description
settings Object
Properties
Name Type Attributes Default Description
templateId Number

사용자 정의 템플릿 ID
Custom template ID
templateArgs Object <optional>

사용자 인자 키와 값
Keys and values of the user argument
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

(static) sendDefault(settings)

Description:

  • 기본 템플릿으로 메시지 보내기
    Send message with default template

Parameters:
Name Type Description
settings DefaultFeedSettings | DefaultListSettings | DefaultLocationSettings | DefaultCommerceSettings | DefaultTextSettings | DefaultCalendarSettings

(static) sendScrap(settings)

Description:

  • 스크랩 메시지 보내기
    Send scrape message

See:
Parameters:
Name Type Description
settings Object
Properties
Name Type Attributes Default Description
requestUrl String

스크랩할 URL
URL to scrape
templateId Number

사용자 정의 템플릿 ID
Custom template ID
templateArgs Object <optional>

사용자 인자 키와 값
Keys and values of the user argument
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

(static) uploadImage(settings) → {Promise.<ImageInfos>}

Description:

  • 이미지 업로드하기
    Upload image

Parameters:
Name Type Description
settings Object
Properties
Name Type Description
file FileList

이미지 파일
Image file
Returns:
Type
Promise.<ImageInfos>

Type Definitions

ButtonObject

Description:

  • 메시지 하단 버튼
    Button at the bottom of the message

Properties:
Name Type Description
title String

버튼 문구
Label for the button
link LinkObject

바로가기 URL
link URL

메시지 하단 버튼
Button at the bottom of the message

Type:
  • Object

CommerceObject

Description:

  • 상품 정보
    Product information

Properties:
Name Type Attributes Default Description
regularPrice Number

정가
Regular price
discountPrice Number <optional>

할인 가격
Discount price
discountRate Number <optional>

할인율
Discount rate
fixedDiscountPrice Number <optional>

정액 할인 가격, discountRate와 함께 사용 불가
Fixed disount price, cannot be used with discountRate
currencyUnit String <optional>
 "원"

화폐 단위
Currency unit
currencyUnitPosition Number <optional>
 0

화폐 단위 표시 위치 (0: 가격 뒤 | 1: 가격 앞)
Position of currency unit (0: After the price | 1: Before the price)
productName String <optional>

상품 이름
Product name

상품 정보
Product information

Type:
  • Object

ContentObject

Description:

  • 메시지 콘텐츠
    Contents for the message

Properties:
Name Type Attributes Description
title String

제목
Title
imageUrl String

이미지 URL
Image URL
link LinkObject

바로가기 URL
Link URL
imageWidth Number <optional>

이미지 너비 (단위: Pixel)
Image width (Unit: Pixel)
imageHeight Number <optional>

이미지 높이 (단위: Pixel)
Image height (Unit: Pixel)
description String <optional>

설명
Description

메시지 콘텐츠
Contents for the message

Type:
  • Object

DefaultCalendarSettings

Description:

  • 캘린더 메시지용 기본 템플릿
    Default template for calendar messages

See:
Properties:
Name Type Attributes Default Description
objectType String

메시지 템플릿 타입, calendar로 고정
Type of the message template, fixed as calendar
idType String

ID 타입 (event: 공개 일정 | calendar: 구독 캘린더)
ID type (event: Public event | calendar: Subscribed calendar)
id String

구독 캘린더 또는 공개 일정 ID
ID for subscribed calendar or public event
content ContentObject

일정 설명
Event description
buttons Array.<ButtonObject> <optional>

메시지 하단 버튼
Button at the bottom of the message
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

캘린더 메시지용 기본 템플릿
Default template for calendar messages

Type:
  • Object

DefaultCommerceSettings

Description:

  • 커머스 메시지용 기본 템플릿
    Default template for commerce messages

See:
Properties:
Name Type Attributes Default Description
objectType String

메시지 템플릿 타입, commerce로 고정
Type of the message template, fixed as commerce
content ContentObject

메시지 콘텐츠
Contents for the message
commerce CommerceObject

상품 정보
Product information
buttonTitle String <optional>

버튼 문구
Label for the button
buttons Array.<ButtonObject> <optional>

메시지 하단 버튼
Button at the bottom of the message
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

커머스 메시지용 기본 템플릿
Default template for commerce messages

Type:
  • Object

DefaultFeedSettings

Description:

  • 피드 메시지용 기본 템플릿
    Default template for feed messages

See:
Properties:
Name Type Attributes Default Description
objectType String

메시지 템플릿 타입, feed로 고정
Type of the message template, fixed as feed
content ContentObject

메시지 콘텐츠
Contents for the message
itemContent ItemContentObject <optional>

아이템 콘텐츠
Item contents
social SocialObject <optional>

소셜 정보
Social information
buttonTitle String <optional>

버튼 문구
Label for the button
buttons Array.<ButtonObject> <optional>

메시지 하단 버튼
Button at the bottom of the message
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

피드 메시지용 기본 템플릿
Default template for feed messages

Type:
  • Object

DefaultListSettings

Description:

  • 리스트 메시지용 기본 템플릿
    Default template for list messages

See:
Properties:
Name Type Attributes Default Description
objectType String

메시지 템플릿 타입, list로 고정
Type of the message template, fixed as list
headerTitle String

헤더 문구
Title of the header
headerLink LinkObject

헤더 바로가기 정보
Link of the header
contents Array.<ContentObject>

메시지 콘텐츠
Contents for the message
buttonTitle String <optional>

버튼 문구
Label for the button
buttons Array.<ButtonObject> <optional>

메시지 하단 버튼
Button at the bottom of the message
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

리스트 메시지용 기본 템플릿
Default template for list messages

Type:
  • Object

DefaultLocationSettings

Description:

  • 위치 메시지용 기본 템플릿
    Default template for location messages

See:
Properties:
Name Type Attributes Default Description
objectType String

메시지 템플릿 타입, location으로 고정
Type of the message template, fixed as location
content ContentObject

메시지 콘텐츠
Contents for the message
address String

주소
Address
addressTitle String <optional>

장소 이름
Name of the place
social SocialObject <optional>

소셜 정보
Social information
buttonTitle String <optional>

버튼 문구
Label for the button
buttons Array.<ButtonObject> <optional>

메시지 하단 버튼
Button at the bottom of the message
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

위치 메시지용 기본 템플릿
Default template for location messages

Type:
  • Object

DefaultTextSettings

Description:

  • 텍스트 메시지용 기본 템플릿
    Default template for text messages

See:
Properties:
Name Type Attributes Default Description
objectType String

메시지 템플릿 타입, text로 고정
Type of the message template, fixed as text
text String

텍스트
Text
link LinkObject

바로가기 정보
Link information
buttonTitle String <optional>

버튼 문구
Label for the button
buttons Array.<ButtonObject> <optional>

메시지 하단 버튼
Button at the bottom of the message
installTalk Boolean <optional>
 false

카카오톡 미설치 시, 설치 페이지 이동 여부
Whether to send the user to the install page if Kakao Talk is not installed
serverCallbackArgs Object | String <optional>

카카오톡 공유 전송 성공 알림에 포함할 키와 값
Keys and values for the Kakao Talk Sharing success callback

텍스트 메시지용 기본 템플릿
Default template for text messages

Type:
  • Object

ImageInfos

Description:

  • 이미지 정보
    Image information

Properties:
Name Type Description
original Object
Properties
Name Type Description
url String

이미지 URL
Image URL
length Number

이미지 파일 크기 (단위: Byte)
Image file size (Unit: Byte)
content_type String

이미지 포맷
Image format
width Number

이미지 너비 (단위: Pixel)
Image width (Unit: Pixel)
height Number

이미지 높이 (단위: Pixel)
Image height (Unit: Pixel)

이미지 정보
Image information

Type:
  • Object

ItemContentObject

Description:

  • 아이템 콘텐츠
    Item contents

Properties:
Name Type Attributes Description
profileText String <optional>

프로필 텍스트
Profile text
profileImageUrl String <optional>

프로필 이미지 URL
Profile image URL
titleImageText String <optional>

이미지 아이템 제목
Title of the image item
titleImageUrl String <optional>

이미지 아이템 이미지 URL
Image URL of the image item
titleImageCategory String <optional>

이미지 아이템 카테고리
Category of the image item
items Array.<ItemObject> <optional>

아이템 정보 (최대: 5개)
Item information (Maximum: 5)
sum String <optional>

요약 정보
Summary
sumOp String <optional>

합산 가격
Total price

아이템 콘텐츠
Item contents

Type:
  • Object

ItemObject

Description:

  • 아이템 정보
    Text information

Properties:
Name Type Description
item String

아이템 이름
Name of the item
itemOp String

아이템 가격
Price of the item

아이템 정보
Text information

Type:
  • Object

LinkObject

Description:

  • 바로가기 정보
    Link information

Properties:
Name Type Attributes Description
webUrl String <optional>

웹 URL
Web URL
mobileWebUrl String <optional>

모바일 웹 URL
Mobile web URL
androidExecutionParams String <optional>

Android 앱 실행 시 전달할 파라미터
Parameters to pass to the Android app
iosExecutionParams String <optional>

iOS 앱 실행 시 전달할 파라미터
Parameters to pass to the iOS app

바로가기 정보
Link information

Type:
  • Object

SocialObject

Description:

  • 소셜 정보
    Social information

Properties:
Name Type Attributes Description
likeCount Number <optional>

좋아요 수
Number of likes
commentCount Number <optional>

댓글 수
Number of comments
sharedCount Number <optional>

공유 수
Number of shares
viewCount Number <optional>

조회 수
Views
subscriberCount Number <optional>

구독 수
Number of subscribers

소셜 정보
Social information

Type:
  • Object