Interface IShare

Static

Since

0.1

Share allows sending a text, an image or a file over other apps on the device. Blacklist works for iOS only.

Hierarchy

NativeMobileComponent<any, MobileOSProps<ShareIOSProps, ShareAndroidProps>>
- IShare

Index

Properties

`Protected` _nativeObject

_nativeObject: any

Accessors

nativeObject

get nativeObject(): any
Returns any
Inherited from NativeMobileComponent.nativeObject
- Defined in core/native-component.ts:11
set nativeObject(value: any): void
Parameters
- value: any
Returns void
Inherited from NativeMobileComponent.nativeObject
- Defined in core/native-component.ts:15

ios

get ios(): TProps["ios"]
Returns TProps["ios"]
Inherited from NativeMobileComponent.ios
- Defined in core/native-mobile-component.ts:49

android

get android(): TProps["android"]
Returns TProps["android"]
Inherited from NativeMobileComponent.android
- Defined in core/native-mobile-component.ts:52

Methods

`Protected` `Abstract` createNativeObject

createNativeObject(params?: Partial<Record<string, any>>): any
Executed before everything. This should return nativeObject since it will be assinged directly to nativeObject.
Parameters
- Optional params: Partial<Record<string, any>>
Returns any
Inherited from NativeMobileComponent.createNativeObject
- Defined in core/native-component.ts:33

`Protected` preConstruct

preConstruct(params?: Partial<Record<string, any>>): void
Parameters
- Optional params: Partial<Record<string, any>>
Returns void
Inherited from NativeMobileComponent.preConstruct
- Defined in core/native-mobile-component.ts:33

`Protected` addAndroidProps

addAndroidProps(props: Partial<ShareAndroidProps>): void
Parameters
- props: Partial<ShareAndroidProps>
Returns void
Inherited from NativeMobileComponent.addAndroidProps
- Defined in core/native-mobile-component.ts:43

`Protected` addIOSProps

addIOSProps(props: Partial<ShareIOSProps>): void
Parameters
- props: Partial<ShareIOSProps>
Returns void
Inherited from NativeMobileComponent.addIOSProps
- Defined in core/native-mobile-component.ts:46

shareText

shareText(text: string, page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>, blacklist?: string[]): void
Shares a text.

Example
```
import Share from '@smartface/native/share';
    Share.shareText("Hello from '@smartface/native'", myPage, [Share.ios.Twitter, Share.ios.Facebook]);
```
Method
shareText

Ios

Android

Since
0.1
Parameters
- text: string
- page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>
- Optional blacklist: string[]
Returns void
- Defined in global/share/share.ts:98

shareImage

shareImage(image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>, page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>, blacklist?: string[]): void
Shares an image.

Example
```
import Share from '@smartface/native/share';
    import Image from '@smartface/native/ui/image';

    var image = Image.createFromFile('path to the image');
    Share.shareImage(image, myPage, []);
```
Method
shareImage

Android

Ios

Since
0.1
Parameters
- image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>
- page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>
- Optional blacklist: string[]
Returns void
- Defined in global/share/share.ts:117

shareFile

shareFile(file: FileImpl, page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>, blacklist?: string[]): void
Shares a file.

Example
```
import Share from '@smartface/native/share';
    import File from '@smartface/native/io/file';

    var file = new File({path: 'path to the file'});
    Share.shareFile(file, myPage, []);
```
Method
shareFile

Ios

Android

Since
0.1
Parameters
- file: FileImpl
- page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>
- Optional blacklist: string[]
Returns void
- Defined in global/share/share.ts:136

shareContacts

shareContacts(params: { items: IContact[]; fileName?: string; page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>; blacklist: string[] }): void
Shares contact.

Method
shareContacts

Ios

Android

See
Contacts Sharing

Since
4.2.1
Parameters
- params: { items: IContact[]; fileName?: string; page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>; blacklist: string[] }
  - items: IContact[]
  - Optional fileName?: string
    
    Specifies vCard file name. Defaults to Contacts
  - page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>
  - blacklist: string[]
Returns void
- Defined in global/share/share.ts:151

share(params: { items: any[]; page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>; blacklist: string[] }): void
Shares file, image & text.

Example
```
import Share from '@smartface/native/share';
    import File from '@smartface/native/io/file';

    var myPage = this; // in page scope
    var file = new File({
        path: 'assets://yourFile.pdf'
    });
    var image = Image.createFromFile("images://smartface.png");
    var text = "Hello from Smartface";
    Share.share({ items: [text, file, image] , page: myPage, blacklist: [Share.ios.Twitter, Share.ios.Facebook]});
```
Method
share

Ios

Android

See
Multiple Sharing

Since
4.0.2
Parameters
- params: { items: any[]; page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>; blacklist: string[] }
  - items: any[]
  - page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>
  - blacklist: string[]
Returns void
- Defined in global/share/share.ts:178

Interface IShare

Static

Since

Hierarchy

Index

Properties

Accessors

Methods

Properties

Protected _nativeObject

Accessors

nativeObject

Returns any

Parameters

value: any

Returns void

ios

Returns TProps["ios"]

android

Returns TProps["android"]

Methods

Protected Abstract createNativeObject

Parameters

Optional params: Partial<Record<string, any>>

Returns any

Protected preConstruct

Parameters

Optional params: Partial<Record<string, any>>

Returns void

Protected addAndroidProps

Parameters

props: Partial<ShareAndroidProps>

Returns void

Protected addIOSProps

Parameters

props: Partial<ShareIOSProps>

Returns void

shareText

Example

Method

Ios

Android

Since

Parameters

text: string

page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>

Optional blacklist: string[]

Returns void

shareImage

Example

Method

Android

Ios

Since

Parameters

image: IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>

page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>

Optional blacklist: string[]

Returns void

shareFile

Example

Method

Ios

Android

Since

Parameters

file: FileImpl

page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>

Optional blacklist: string[]

Returns void

shareContacts

Method

Ios

Android

See

Since

Parameters

params: { items: IContact[]; fileName?: string; page: IPage<"load" | "dismissComplete" | "dismissStart" | "dismissCancel" | "hide" | "show" | "orientationChange" | "safeAreaPaddingChange", MobileOSProps<PageIOSParams, PageAndroidParams>, any>; blacklist: string[] }

items: IContact[]

Optional fileName?: string

`Protected` _nativeObject

`Protected` `Abstract` createNativeObject

`Optional` params: Partial<Record<string, any>>

`Protected` preConstruct

`Optional` params: Partial<Record<string, any>>

`Protected` addAndroidProps

`Protected` addIOSProps

`Optional` blacklist: string[]

`Optional` blacklist: string[]

`Optional` blacklist: string[]

`Optional` fileName?: string