Skip to main content

Class: AWSClientPlugin

Extra-Helpers.AWSClientPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "AWSClientPlugin1"

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:12


uiConfig

Optional uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:13


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:15


dependencies

dependencies: typeof FileTransferPlugin[]

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:20


accessKeyId

accessKeyId: string = ''

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:30


accessKeySecret

accessKeySecret: string = ''

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:36


endpointURL

endpointURL: string = ''

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:42


pathPrefix

pathPrefix: string = 'webgi'

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:48


serializeSettings

serializeSettings: boolean = false

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:54


serializeWithViewer

Readonly serializeWithViewer: false

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:100


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


connected

get connected(): boolean

Returns

boolean

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:92


client

get client(): undefined | AwsClient

Returns

undefined | AwsClient

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:95

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40


fromJSON

fromJSON(data, meta?): null | AWSClientPlugin | Promise<null | AWSClientPlugin>

Parameters

NameType
dataany
meta?any

Returns

null | AWSClientPlugin | Promise<null | AWSClientPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

loadState(prefix?, storage?): Promise<void>

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


toggleConnection

toggleConnection(): void

Returns

void

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:59


connect

connect(): void

Returns

void

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:67


refreshUi

refreshUi(): void

Returns

void

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:80


disconnect

disconnect(): void

Returns

void

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:84


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:102


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:107


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

Constructors

constructor

new AWSClientPlugin()

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/extras/network/AWSClientPlugin.ts:22