Options
All
  • Public
  • Public/Protected
  • All
Menu

@helium/react-native-sdk

Index

Type aliases

DiagnosticInfo

DiagnosticInfo: { connected: string; dialable: string; disk: string; eth: string; fw: string; height: string; ip: string; nat_type: string; wifi: string }

Type declaration

  • connected: string
  • dialable: string
  • disk: string
  • eth: string
  • fw: string
  • height: string
  • ip: string
  • nat_type: string
  • wifi: string

Variables

Const heliumHttpClient

heliumHttpClient: default = ...

The heliumHttpClient provides access to the Helium Blockchain API. You can find the Client documentation in the helium-js repo.

This client uses the Helium Blockchain API by default, you also have the option to host your own blockchain API. To use a custom blockchain api see createHttpClient.

Functions

Const HotspotBleProvider

  • HotspotBleProvider(__namedParameters: { children: ReactNode }): Element
  • This is a react component that is required to use the HotspotBleManager. It must wrap your apps root component.

    For example:

    <HotspotBleProvider>
        <YourRootAppComponent />
    </HotspotBleProvider>
    

    Parameters

    • __namedParameters: { children: ReactNode }
      • children: ReactNode

    Returns Element

Const OnboardingProvider

  • OnboardingProvider(__namedParameters: { baseUrl?: string; children: ReactNode }): Element
  • This is a react component that is required to use the OnboardingManager. It must wrap your apps root component.

    For example:

    <OnboardingProvider>
        <YourRootAppComponent />
    </OnboardingProvider>
    

    or if you will be using your own onboarding server

    <OnboardingProvider baseUrl="https://youronboardingserver.com">
        <YourRootAppComponent />
    </OnboardingProvider>
    

    Parameters

    • __namedParameters: { baseUrl?: string; children: ReactNode }
      • Optional baseUrl?: string
      • children: ReactNode

    Returns Element

Const createHttpClient

  • createHttpClient(baseURL: string): Promise<default>
  • If you don't want to use the Helium Blockchain API you can host your own blockchain api and use this method to create a client.

    For example:

    const customHttpClient = await createHttpClient("https://blockchain-base-url.com")
    await customHttpClient.transactions.submit(txn)
    

    Parameters

    • baseURL: string

    Returns Promise<default>

multiply

  • multiply(a: number, b: number): Promise<number>
  • Parameters

    • a: number
    • b: number

    Returns Promise<number>

Const useHotspotBle

Const useOnboarding

Generated using TypeDoc