Class SDK<V>

SDK main class

Instances are created via static methods below. Direct construction is intentionally disabled.

Creation

OJP.SDK.create( ... ) for OJPv2 instance
OJP.SDK.v1( ... ) for legacy (OJPv1) instance

Type Parameters

V extends OJP_VERSION = "2.0"

Index

Initialization

Properties

httpConfig language requestorRef version

Initialization

`Static`create

create(
    requestorRef: string,
    httpConfig: HTTPConfig,
    language?: Language,
): SDK<"2.0">
Create OJPv2 SDK
Parameters
- requestorRef: string
  string used for sending <RequestorRef> to OJP backend, be careful not to use a too much generic value
- httpConfig: HTTPConfig
  see HTTPConfig
- language: Language = 'en'
Returns SDK<"2.0">
- Defined in src/sdk.ts:77

`Static`v1

v1(
    requestorRef: string,
    httpConfig: HTTPConfig,
    language?: Language,
): SDK<"1.0">
Create OJPv1 SDK
Parameters
- requestorRef: string
  string used for sending RequestorRef to OJP backend, be careful not to use a too much generic value
- httpConfig: HTTPConfig
  see HTTPConfig
- language: Language = 'en'
Returns SDK<"1.0">
- Defined in src/sdk.ts:90

Properties

httpConfig

httpConfig: HTTPConfig

language

language: Language

requestorRef

requestorRef: string

`Readonly`version

version: OJP_VERSION