@telegram-apps/sdk
Version:
TypeScript Source Development Kit for Telegram Mini Apps client application.
42 lines (41 loc) • 1.42 kB
TypeScript
export interface ShareStoryOptions {
/**
* The caption to be added to the media.
* 0-200 characters for regular users and 0-2048 characters for premium subscribers.
* @see https://telegram.org/faq_premium#telegram-premium
*/
text?: string;
/**
* An object that describes a widget link to be included in the story.
* Note that only premium subscribers can post stories with links.
* @see https://telegram.org/faq_premium#telegram-premium
*/
widgetLink?: {
/**
* The URL to be included in the story.
*/
url: string;
/**
* The name to be displayed for the widget link, 0-48 characters.
*/
name?: string;
};
}
/**
* Opens the native story editor.
* @since Mini Apps v7.8
* @throws {FunctionNotAvailableError} The function is not supported
* @throws {FunctionNotAvailableError} The environment is unknown
* @throws {FunctionNotAvailableError} The SDK is not initialized
* @example
* if (shareStory.isAvailable()) {
* shareStory('https://example.com/background.png', {
* text: 'Look at this cool group!',
* widgetLink: {
* url: 'https://t.me/heyqbnk',
* name: 'Vlad\'s community',
* },
* });
* }
*/
export declare const shareStory: import('../../wrappers/wrapSafe.js').SafeWrapped<(mediaUrl: string, options?: ShareStoryOptions) => void, true, never>;