Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Bluedot

This interface is the high-level entry point for integration with the Bluedot Javascript SDK.
To use the SDK, it is necessary to initialize with your projectId.
It allows you to send Wave events, create Hello Screen orders or refesh the SDK with reset function.

Hierarchy

  • Bluedot

Index

Properties

Properties

config

config: Configuration

Set common configurations for the Bluedot SDK

credentials

credentials: Credentials

Manage the userToken that is passed along with all events. This is used to validate subsequent events relating to registered orders.

initialize

initialize: (projectId: string, options?: InitializeOptions) => Promise<void>

Initialize Bluedot service with a given projectId. The given projectId will be searched against the GlobalConfig and return corresponding configurations.

param

The Project ID of a project can be found in the Projects section of Canvas.

param

an optional options object containing extra configurable properties

throws

ValidationError If the projectId is not a valid UUID.

Type declaration

reset

reset: () => void

Halt all SDK activities and reset all states to as it was before initialization. The installRef for the project should, however, still be stored.

Type declaration

    • (): void

    • Returns void

setLocationEnabled

setLocationEnabled: (locationEnabled: boolean) => void

Accepts a flag to request location from a browser. Note this cannot guarantee location will be provided as the user has to provide location permissions

param
throws

InvalidInputTypeError If locationEnabled is not a boolean

throws

LocationAPINotAvailableError if location api is not available in the environment(i.e nodejs)

Type declaration

    • (locationEnabled: boolean): void

    • Parameters

      • locationEnabled: boolean

      Returns void

wave

wave: Wave

Wave is a lightweight API that provides customer order updates that can be used on any platform. This data then propagates through the Bluedot Arrival platform, updating user status appropriately and firing any webhooks attached.

Generated using TypeDoc