Class: AWSClientPlugin
Extra-Helpers.AWSClientPlugin
Hierarchy
AViewerPlugin<"fileUpload">↳
AWSClientPlugin
Properties
PluginType
▪ Static Readonly PluginType: "AWSClientPlugin1"
Defined in
webgi/src/extras/network/AWSClientPlugin.ts:12
USE_PROXY
▪ Static USE_PROXY: boolean = false
Set to true to use a proxy for all requests.
This can be used to move the access credentials to the server side.
This is required for some services like cloudflare R2 that do not support CORS.
usage: AWSClientPlugin.USE_PROXY = true, optionally set AWSClientPlugin.PROXY_URL to a custom proxy.
Defined in
webgi/src/extras/network/AWSClientPlugin.ts:73
PROXY_URL
▪ Static PROXY_URL: string = 'https://r2-s3-api.repalash.workers.dev/{path}'
Defined in
webgi/src/extras/network/AWSClientPlugin.ts:74
uiConfig
• Optional uiConfig: UiObjectConfig<any, string>
Defined in
webgi/src/extras/network/AWSClientPlugin.ts:13
enabled
• enabled: boolean = true
Overrides
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:109
_dirty
• Protected _dirty: boolean = false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
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
| Name | Type |
|---|---|
value | boolean |
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:101
client
• get client(): undefined | AwsClient
Returns
undefined | AwsClient
Defined in
webgi/src/extras/network/AWSClientPlugin.ts:104
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:36
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:40
fromJSON
▸ fromJSON(data, meta?): null | AWSClientPlugin | Promise<null | AWSClientPlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | AWSClientPlugin | Promise<null | AWSClientPlugin>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:52
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:64
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:67
storeState
▸ storeState(prefix?, storage?, data?): void
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:74
loadState
▸ loadState(prefix?, storage?): Promise<void>
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
Returns
Promise<void>
Inherited from
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:76
refreshUi
▸ refreshUi(): void
Returns
void
Defined in
webgi/src/extras/network/AWSClientPlugin.ts:89
disconnect
▸ disconnect(): void
Returns
void
Defined in
webgi/src/extras/network/AWSClientPlugin.ts:93
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Overrides
Defined in
webgi/src/extras/network/AWSClientPlugin.ts:111
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
Defined in
webgi/src/extras/network/AWSClientPlugin.ts:116
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:60
Constructors
constructor
• new AWSClientPlugin()