Class DDClient<AuthStateArgs>

Type parameters

AuthStateArgs = unknown

Hierarchy

DDClient

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DDClient<AuthStateArgs>(options?: ClientOptions<AuthStateArgs>): DDClient<AuthStateArgs>

- Defined in packages/ui-extensions-sdk/src/client/client.ts:59
Type parameters
- AuthStateArgs = unknown
Parameters
- options: ClientOptions<AuthStateArgs> = {}
Returns DDClient<AuthStateArgs>

Properties

api

api: DDAPIClient

auth

auth: DDAuthClient<AuthStateArgs>

config

config: DDConfigClient

dashboard

dashboard: DDDashboardClient

debug

debug: boolean

events

events: DDEventsClient<AuthStateArgs>

location

location: DDLocationClient

modal

modal: DDModalClient

notification

notification: DDNotificationClient

sidePanel

sidePanel: DDSidePanelClient

widgetContextMenu

widgetContextMenu: DDWidgetContextMenuClient

Methods

getContext

getContext(): Promise<Context>

Implementation of ContextClient.getContext
- Defined in packages/ui-extensions-sdk/src/client/client.ts:199
Returns app context data, after it is sent from the parent

Returns Promise<Context>

log

log(message: string): void

Implementation of LoggerClient.log
- Defined in packages/ui-extensions-sdk/src/client/client.ts:118
Parameters
- message: string
Returns void

logError

logError(message: string): void

Implementation of LoggerClient.logError
- Defined in packages/ui-extensions-sdk/src/client/client.ts:126
Parameters
- message: string
Returns void

logWarning

logWarning(message: string): void

Implementation of LoggerClient.logWarning
- Defined in packages/ui-extensions-sdk/src/client/client.ts:122
Parameters
- message: string
Returns void

on

on<T>(eventType: EventType, eventHandler: EventHandler<T>): () => void

Implementation of EventClient.on
- Defined in packages/ui-extensions-sdk/src/client/client.ts:130
Type parameters
- T = unknown
Parameters
- eventType: EventType
- eventHandler: EventHandler<T>
Returns () => void
- - (): void
  - Returns void

onRequest

onRequest<Q, R>(requestType: RequestType, requestHandler: RequestHandler<Q, R>): () => void

Implementation of RequestClient.onRequest
- Defined in packages/ui-extensions-sdk/src/client/client.ts:137
Type parameters
- Q = unknown
- R = unknown
Parameters
- requestType: RequestType
- requestHandler: RequestHandler<Q, R>
Returns () => void
- - (): void
  - Returns void

request

request<Q, R>(requestType: RequestType, requestData?: Q): Promise<R>

Implementation of RequestClient.request
- Defined in packages/ui-extensions-sdk/src/client/client.ts:144
Type parameters
- Q = unknown
- R = unknown
Parameters
- requestType: RequestType
- Optional requestData: Q
Returns Promise<R>

resize

resize(dimensions?: Partial<IFrameDimensions>): void

- Defined in packages/ui-extensions-sdk/src/client/client.ts:178
Notify the parent that the iframe should be resized.

Will default any dimensions not given to the iframe's actual dimensions.

There's no guarantee that the parent will adjust the iframe's dimensions. The parent will also sanitize the dimensions attempting to keep the iframe within the viewport.

Parameters
- Optional dimensions: Partial<IFrameDimensions>
Returns void

send

send<T>(eventType: EventType, eventData: T): Promise<void>

Implementation of EventClient.send
- Defined in packages/ui-extensions-sdk/src/client/client.ts:151
Type parameters
- T = unknown
Parameters
- eventType: EventType
- eventData: T
Returns Promise<void>

Generated using TypeDoc