@utae/react-native-kakao-share-link/lib/typescript/index.d.ts

리액트 네이티브로 사용하는 카카오톡으로 공유하기. Kakao SDK v2를 사용한 카카오 링크(공유).

/**
 * ContentType
 * @description 카카오 링크 본문 내용 타입
 * @property title        제목
 * @property imageUrl     이미지 url
 * @property link         클릭 시 열리는 링크
 * @property description  설명 (Option)
 * @property imageWidth   이미지 가로 길이 (Option)
 * @property imageHeight  이미지 세로 길이 (Option)
 */
export declare type ContentType = {
    title: string;
    imageUrl: string;
    link: LinkType;
    description?: string;
    imageWidth?: number;
    imageHeight?: number;
};
/**
 * ExecutionParamType
 * @description ios, android 딥링크에 사용될 key, value
 * @property key    딥링크 key
 * @property value  딥링크 value
 */
export declare type ExecutionParamType = {
    key: string;
    value: string;
};
/**
 * LinkType
 * @description 클릭 시 열리는 링크 타입 (이 중 하나는 반드시 존재해야 함)
 * @property webUrl                   웹 페이지 링크 (Option)
 * @property mobileWebUrl             모바일일 경우 웹 페이지 링크 (Option)
 * @property iosExecutionParams       ios 딥링크 (Option)
 * @property androidExecutionParams   android 딥링크 (Option)
 */
export declare type LinkType = {
    webUrl?: string;
    mobileWebUrl?: string;
    iosExecutionParams?: ExecutionParamType[];
    androidExecutionParams?: ExecutionParamType[];
};
/**
 * CommerceType
 * @description 상품 타입
 * @property regularPrice         정가
 * @property discountPrice        할인된 가격 (Option)
 * @property discountRate         할인율 (Option)
 * @property fixedDiscountPrice   정액 할인 가격 (Option)
 * @property productName          상품명 (Option)
 */
export declare type CommerceType = {
    regularPrice: number;
    discountPrice?: number;
    discountRate?: number;
    fixedDiscountPrice?: number;
    productName?: string;
};
/**
 * ButtonType
 * @description 버튼 타입
 * @property title  버튼 타이틀
 * @property link   버튼 링크 타입
 */
export declare type ButtonType = {
    title: string;
    link: LinkType;
};
/**
 * SocialType
 * @description 소셜 타입
 * @property commentCount     댓글 수 (Option)
 * @property likeCount        좋아요 수 (Option)
 * @property sharedCount      공유 수 (Option)
 * @property subscriberCount  구독 수 (Option)
 * @property viewCount        조회 수 (Option)
 */
export declare type SocialType = {
    commentCount?: number;
    likeCount?: number;
    sharedCount?: number;
    subscriberCount?: number;
    viewCount?: number;
};
/**
 * SendResultType
 * @description 공유 결과 타입
 * @property result   성공 여부
 * @property intent   카카오 링크 정보 (android only)
 * @property warning  경고 메세지 (android only)
 * @property argument 카카오 링크 argument (android only)
 * @property callback 카카오 링크 후 콜백 데이터 (android only)
 */
export declare type SendResultType = {
    result: boolean;
    intent?: string;
    warning?: string;
    argument?: string;
    callback?: string;
};
/**
 * CallbackType
 * @description 카카오 링크 콜백 타입 (error, result 둘 중 하나만 존재)
 * @property error    에러
 * @property result   결과
 */
export declare type CallbackType = (error?: Error, result?: SendResultType) => void;
/**
 * CommerceTemplateType
 * @description 상품 공유하기
 * @property content      내용
 * @property commerce     상품 정보
 * @property buttons      버튼 배열 (Option)
 * @property buttonTitle  버튼이 하나일 때 버튼의 타이틀 (Option)
 */
export declare type CommerceTemplateType = {
    content: ContentType;
    commerce: CommerceType;
    buttons?: ButtonType[];
    buttonTitle?: String;
};
/**
 * ListTemplateType
 * @description 리스트 공유하기
 * @property headerTitle  리스트 헤더 타이틀
 * @property headerLink   리스트 헤더 클릭 링크
 * @property contents     리스트 각각의 내용
 * @property buttons      버튼 배열 (Option)
 * @property buttonTitle  버튼이 하나일 때 버튼의 타이틀 (Option)
 */
export declare type ListTemplateType = {
    headerTitle: string;
    headerLink: LinkType;
    contents: ContentType[];
    buttons?: ButtonType[];
    buttonTitle?: string;
};
/**
 * FeedTemplateType
 * @description 피드 공유하기
 * @property content      내용
 * @property social       피드 정보 (Option)
 * @property buttons      버튼 배열 (Option)
 * @property buttonTitle  버튼이 하나일 때 버튼의 타이틀 (Option)
 */
export declare type FeedTemplateType = {
    content: ContentType;
    social?: SocialType;
    buttons?: ButtonType[];
    buttonTitle?: String;
};
/**
 * LocationTemplateType
 * @description 위치 공유하기
 * @property address        상세 주소 (00구 00동 000-00)
 * @property addressTitle   주소 명칭 (00아파트, 00상가)
 * @property content        내용
 * @property social         피드 정보 (Option)
 * @property buttons        버튼 배열 (Option)
 * @property buttonTitle    버튼이 하나일 때 버튼의 타이틀 (Option)
 */
export declare type LocationTemplateType = {
    address: string;
    addressTitle?: string;
    content: ContentType;
    social?: SocialType;
    buttons?: ButtonType[];
    buttonTitle?: string;
};
/**
 * TextTemplateType
 * @description 텍스트 공유하기
 * @property text           텍스트
 * @property link           링크 타입
 * @property buttons        버튼 배열 (Option)
 * @property buttonTitle    버튼이 하나일 때 버튼의 타이틀 (Option)
 */
export declare type TextTemplateType = {
    text: string;
    link: LinkType;
    buttons?: ButtonType[];
    buttonTitle?: string;
};
/**
 * CustomTemplateType
 * @description 사용자가 미리 생성한 메시지 템플릿 공유하기
 * @property templateId   템플릿 id
 * @property templateArgs 템플릿 args (key, value 형식) (Option)
 */
export declare type CustomTemplateType = {
    templateId: number;
    templateArgs?: ExecutionParamType[];
};
/**
 * BrowserNotFoundError
 * @description 카카오톡 미설치 시 브라우저를 통해 공유하기 기능이 실행되는데 브라우저를 찾지 못한 경우 발생하는 에러
 */
export declare class BrowserNotFoundError extends Error {
}
/**
 * sendCommerce
 * @param {CommerceTemplateType} commerceTemplate CommerceTemplate Item
 * @param {CallbackType} [callback] callback function
 * @returns {Promise<SendResultType>}
 */
export declare const sendCommerce: (commerceTemplate: CommerceTemplateType, callback?: CallbackType | undefined) => Promise<SendResultType>;
/**
 * sendList
 * @param {ListTemplateType} listTemplate ListTemplate Item
 * @param {CallbackType} [callback] callback function
 * @returns {Promise<SendResultType>}
 */
export declare const sendList: (listTemplate: ListTemplateType, callback?: CallbackType | undefined) => Promise<SendResultType>;
/**
 * sendFeed
 * @param {FeedTemplateType} feedTemplate FeedTemplate Item
 * @param {CallbackType} [callback] callback function
 * @returns {Promise<SendResultType>}
 */
export declare const sendFeed: (feedTemplate: FeedTemplateType, callback?: CallbackType | undefined) => Promise<SendResultType>;
/**
 * sendText
 * @param {TextTemplateType} textTemplate TextTemplate Item
 * @param {CallbackType} [callback] callback function
 * @returns {Promise<SendResultType>}
 */
export declare const sendText: (textTemplate: TextTemplateType, callback?: CallbackType | undefined) => Promise<SendResultType>;
/**
 * sendLocation
 * @param {LocationTemplateType} locationTemplate LocationTemplate Item
 * @param {CallbackType} [callback] callback function
 * @returns {Promise<SendResultType>}
 */
export declare const sendLocation: (locationTemplate: LocationTemplateType, callback?: CallbackType | undefined) => Promise<SendResultType>;
/**
 * sendCustom
 * @param {CustomTemplateType} customTemplate CustomTemplate Item
 * @param {CallbackType} [callback] callback function
 * @returns {Promise<SendResultType>}
 */
export declare const sendCustom: (customTemplate: CustomTemplateType, callback?: CallbackType | undefined) => Promise<SendResultType>;
export declare type KakaoShareLinkType = {
    sendCommerce: typeof sendCommerce;
    sendList: typeof sendList;
    sendFeed: typeof sendFeed;
    sendText: typeof sendText;
    sendLocation: typeof sendLocation;
    sendCustom: typeof sendCustom;
};
declare const _default: KakaoShareLinkType;
export default _default;