공유 (Share)
OS 기본 공유 시트 및 카카오톡 공유를 실행하는 모듈입니다.
개요
appify.share는 시스템 공유 기능과 카카오톡 템플릿 공유 기능을 제공합니다. systemShare는 iOS 공유 시트 및 Android 공유 인텐트를 호출하며, kakaoShare는 카카오 디벨로퍼스에 등록된 메시지 템플릿을 사용합니다. 두 메서드 모두 사용자가 공유를 취소하면 false를 반환합니다.
API
systemShare(options: ShareOptions): Promise<boolean>
OS 기본 공유 시트를 호출합니다.
매개변수
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| options | ShareOptions | 예 | 공유 옵션 객체 |
| options.message | string | 아니오 | 공유 본문 텍스트 |
| options.url | string | 아니오 | 공유할 URL |
| options.title | string | 아니오 | 공유 제목 (Android에서 주로 사용) |
반환값: Promise<boolean> - 공유 성공 여부 (false는 사용자 취소 포함)
예제
import { appify } from '@nolraunsoft/appify-sdk';
const success = await appify.share.systemShare({
title: 'Appify SDK',
message: '하이브리드 앱 개발을 위한 최고의 도구',
url: 'https://appify.com',
});
kakaoShare(options: KakaoShareOptions): Promise<boolean>
카카오 디벨로퍼스 메시지 템플릿을 사용하여 카카오톡으로 공유합니다.
매개변수
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| options | KakaoShareOptions | 예 | 카카오 공유 옵션 객체 |
| options.templateId | number | 아니오 | 카카오 디벨로퍼스 메시지 템플릿 ID |
| options.templateArgs | Record<string, string> | 아니오 | 템플릿에 전달할 파라미터 객체 |
반환값: Promise<boolean> - 공유 성공 여부
예제
import { appify } from '@nolraunsoft/appify-sdk';
const success = await appify.share.kakaoShare({
templateId: 12345,
templateArgs: {
name: '홍길동',
code: 'ABCDEF',
},
});
플랫폼별 참고사항
kakaoShare는 카카오톡이 설치된 기기에서만 동작합니다. 미설치 시false를 반환합니다.- iOS에서
systemShare의title옵션은 일부 공유 대상에서 무시될 수 있습니다.