Class FWNavigator

You can use this class for pushing RN page from the native page.

Hierarchy

FWNavigator

Index

Methods

canPopNativeContainer popNativeContainer pushNativeContainer startFloatingPlayer stopFloatingPlayer getInstance

Methods

canPopNativeContainer

canPopNativeContainer(): Promise<boolean>
Indicate if we can pop top-most native container.

Returns
If the result is true, we could call popNativeContainer to pop top-most native container.

Deprecated
The method will be deprecated since RN SDK V2.0.

Returns Promise<boolean>

popNativeContainer

popNativeContainer(): Promise<boolean>
Pop top-most native container.

Returns
The result of poping top-most native container.

Returns Promise<boolean>

pushNativeContainer

pushNativeContainer(props: FWNativeContainerProps): Promise<boolean>
Push a new native container. We will render your app component in new native container. Please set your app component name through FireworkSDK.getInstance().appComponentName before calling this method

Returns
The result of pushing RN page from native page.

Deprecated
The method will be deprecated since RN SDK V2.0.
Parameters
- props: FWNativeContainerProps
  
  We will pass the props to your app component.
Returns Promise<boolean>

startFloatingPlayer

startFloatingPlayer(): Promise<boolean>
Change current fullscreen player to floating player.

Returns
If the result is true, it means that the fullscreen player is changed to floating player. Only supported on iOS.

Returns Promise<boolean>

stopFloatingPlayer

stopFloatingPlayer(): Promise<void>
Stop current floating player. Only supported on iOS.

Returns Promise<void>

`Static` getInstance

getInstance(): FWNavigator
Returns FWNavigator

Generated using TypeDoc