Options
All
  • Public
  • Public/Protected
  • All
Menu

Share

Methods to share via system share sheet.

Example

let s = "My text to share"

let didShare = Share.shareAsText(s);
let didShare = Share.shareAsURL("http://getdrafts.com/");
let didShare = Share.shareAsFile("My-File.txt", s);

Hierarchy

  • Share

Index

Methods

Static shareAsFile

  • shareAsFile(filename: string, text: string): boolean
  • Open system share sheet to share the content as a file, with the specified file name (with e). Returns true if share was completed by user amd false if input was invalid or user cancelled share. Drafts will create a temporary file for the purposes of the share and send it to the share sheet. The temporary file will be deleted after. Useful, for example, to create a text file and share to Mail, and it will be shared as an attachment to the email

    Parameters

    • filename: string
    • text: string

    Returns boolean

Static shareAsText

  • shareAsText(text: string): boolean
  • Open system share sheet to share the string provided as text. Returns true if share was completed by user, false if input was invalid or user cancelled the share.

    Parameters

    • text: string

    Returns boolean

Static shareAsURL

  • shareAsURL(url: string): boolean
  • Open system share sheet to share the url provided as a URL object. Returns true if share was completed by user and false if input was invalid or user cancelled share.

    Parameters

    • url: string

      should be a complete and valid URL

    Returns boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc