Class PlatformNext

Hierarchy

PlatformNext

Index

Constructors

constructor

new PlatformNext(): PlatformNext
Returns PlatformNext
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:56

Properties

`Private` _agent

_agent: ILocalAgent

`Private` _credentials

_credentials: PlatformCredentials

`Private` _endpoint

_endpoint: string = DEFAULT_ENDPOINT

`Private` cachedLatencies

cachedLatencies: RegionalLatencyMeasurement[]

`Private` requestOptions

requestOptions: {
cors: boolean;
mode: RequestMode;
}

Type declaration

cors: boolean
mode: RequestMode

Accessors

agent

get agent(): ILocalAgent
Returns ILocalAgent
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:39
set agent(value): void
Parameters
- value: ILocalAgent
Returns void
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:42

credentials

get credentials(): PlatformCredentials
Returns PlatformCredentials
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:25
set credentials(value): void
Parameters
- value: PlatformCredentials
Returns void
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:28

endpoint

get endpoint(): string
Returns string
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:46
set endpoint(value): void
Parameters
- value: string
Returns void
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:49

`Static` info

get info(): string
Returns string
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:68

`Static` version

get version(): string
Returns string
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:64

Methods

connect

connect(timeoutMs?): Promise<ILocalAgent>
Connects to the PureWeb Platform
Parameters
- Optional timeoutMs: number
  
  A timeout in milliseconds for how long to wait for the connection to establish. Defaults to 30s.
Returns Promise<ILocalAgent>
A local, connected, agent
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:77

disconnect

disconnect(): void
Returns void
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:110

getLatencyMeasurements

getLatencyMeasurements(): Promise<RegionalLatencyMeasurement[]>
Returns Promise<RegionalLatencyMeasurement[]>
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:114

getModel

getModel(modelId, version): Promise<ModelDefinition>
Parameters
- modelId: string
- version: string
Returns Promise<ModelDefinition>
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:193

getModels

getModels(): Promise<ModelDefinition[]>
Returns Promise<ModelDefinition[]>
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:176

getProject

getProject(id): Promise<Project>
Parameters
- id: string
Returns Promise<Project>
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:227

getProvisionedModels

getProvisionedModels(id, version): Promise<ProvisionedModel[]>
Parameters
- id: string
- version: string
Returns Promise<ProvisionedModel[]>
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:210

initialize

initialize(options): void
Parameters
- options: {
  endpoint?: string;
  }
  - Optional endpoint?: string
Returns void
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:121

isAuthenticated

isAuthenticated(): boolean
Returns boolean
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:53

launchRequestAcknowledgements

launchRequestAcknowledgements(kind, message): Promise<void>
Parameters
- kind: LaunchRequestAcknowledgementType
- message: string
Returns Promise<void>
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:284

requestModel

requestModel(model, virtualizationProviderOverride?, latencyOverride?): Promise<ILaunchRequest>
Parameters
- model: ModelDefinition
- Optional virtualizationProviderOverride: string
- Optional latencyOverride: RegionalLatencyMeasurement[]
Returns Promise<ILaunchRequest>
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:242

useAnonymousCredentials

useAnonymousCredentials(projectId, environmentId?): Promise<PlatformCredentials>
Parameters
- projectId: string
- Optional environmentId: string
Returns Promise<PlatformCredentials>
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:127

useSessionCredentials

useSessionCredentials(projectId, projectToken, environmentId?): Promise<PlatformCredentials>
Parameters
- projectId: string
- projectToken: string
- Optional environmentId: string
Returns Promise<PlatformCredentials>
- Defined in packages/platform-sdk/src/platform/PlatformNext.ts:151

Generated using TypeDoc