Class Federation

Hierarchy

Federation

Index

Constructors

Properties

Methods

Constructors

constructor

new Federation(__namedParameters: Ctor): Federation
Parameters
- __namedParameters: Ctor
Returns Federation
- Defined in federation.ts:44

Properties

`Protected` `Optional` accessTokenFn

accessTokenFn?: (() => undefined | string)

Type declaration

- (): undefined | string
- Returns undefined | string

`Protected` `Optional` baseURL

baseURL?: string

`Protected` headers

headers: Headers = {}

Methods

api

api(): AxiosInstance
Returns AxiosInstance
- Defined in federation.ts:80

manageStructureCreateExposed

manageStructureCreateExposed(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:590

manageStructureCreateExposedCancellable

manageStructureCreateExposedCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:631

manageStructureCreateExposedEndpoint

manageStructureCreateExposedEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:643

manageStructureCreateMappings

manageStructureCreateMappings(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:803

manageStructureCreateMappingsCancellable

manageStructureCreateMappingsCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:838

manageStructureCreateMappingsEndpoint

manageStructureCreateMappingsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:850

manageStructureListAll

manageStructureListAll(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:906

manageStructureListAllCancellable

manageStructureListAllCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:932

manageStructureListAllEndpoint

manageStructureListAllEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:944

manageStructureReadExposed

manageStructureReadExposed(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:547

manageStructureReadExposedCancellable

manageStructureReadExposedCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:569

manageStructureReadExposedEndpoint

manageStructureReadExposedEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:581

manageStructureReadMappings

manageStructureReadMappings(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:859

manageStructureReadMappingsCancellable

manageStructureReadMappingsCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:885

manageStructureReadMappingsEndpoint

manageStructureReadMappingsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:897

manageStructureReadShared

manageStructureReadShared(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:760

manageStructureReadSharedCancellable

manageStructureReadSharedCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:782

manageStructureReadSharedEndpoint

manageStructureReadSharedEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:794

manageStructureRemoveExposed

manageStructureRemoveExposed(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:717

manageStructureRemoveExposedCancellable

manageStructureRemoveExposedCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:739

manageStructureRemoveExposedEndpoint

manageStructureRemoveExposedEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:751

manageStructureUpdateExposed

manageStructureUpdateExposed(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:651

manageStructureUpdateExposedCancellable

manageStructureUpdateExposedCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:696

manageStructureUpdateExposedEndpoint

manageStructureUpdateExposedEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:708

nodeCreate

nodeCreate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:192

nodeCreateCancellable

nodeCreateCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:213

nodeCreateEndpoint

nodeCreateEndpoint(): string
Returns string
- Defined in federation.ts:225

nodeDelete

nodeDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:351

nodeDeleteCancellable

nodeDeleteCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:369

nodeDeleteEndpoint

nodeDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:381

nodeGenerateUri

nodeGenerateUri(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:268

nodeGenerateUriCancellable

nodeGenerateUriCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:286

nodeGenerateUriEndpoint

nodeGenerateUriEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:298

nodeHandshakeComplete

nodeHandshakeComplete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:503

nodeHandshakeCompleteCancellable

nodeHandshakeCompleteCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:527

nodeHandshakeCompleteEndpoint

nodeHandshakeCompleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:539

nodeHandshakeConfirm

nodeHandshakeConfirm(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:465

nodeHandshakeConfirmCancellable

nodeHandshakeConfirmCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:483

nodeHandshakeConfirmEndpoint

nodeHandshakeConfirmEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:495

nodeHandshakeInitialize

nodeHandshakeInitialize(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:95

nodeHandshakeInitializeCancellable

nodeHandshakeInitializeCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:129

nodeHandshakeInitializeEndpoint

nodeHandshakeInitializeEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:141

nodePair

nodePair(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:427

nodePairCancellable

nodePairCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:445

nodePairEndpoint

nodePairEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:457

nodeRead

nodeRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:230

nodeReadCancellable

nodeReadCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:248

nodeReadEndpoint

nodeReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:260

nodeSearch

nodeSearch(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:149

nodeSearchCancellable

nodeSearchCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:175

nodeSearchEndpoint

nodeSearchEndpoint(): string
Returns string
- Defined in federation.ts:187

nodeUndelete

nodeUndelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:389

nodeUndeleteCancellable

nodeUndeleteCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:407

nodeUndeleteEndpoint

nodeUndeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:419

nodeUpdate

nodeUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:306

nodeUpdateCancellable

nodeUpdateCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:331

nodeUpdateEndpoint

nodeUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:343

permissionsDelete

permissionsDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1352

permissionsDeleteCancellable

permissionsDeleteCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1370

permissionsDeleteEndpoint

permissionsDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:1382

permissionsEffective

permissionsEffective(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1240

permissionsEffectiveCancellable

permissionsEffectiveCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1256

permissionsEffectiveEndpoint

permissionsEffectiveEndpoint(): string
Returns string
- Defined in federation.ts:1268

permissionsList

permissionsList(extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1212

permissionsListCancellable

permissionsListCancellable(extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1223

permissionsListEndpoint

permissionsListEndpoint(): string
Returns string
- Defined in federation.ts:1235

permissionsRead

permissionsRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1310

permissionsReadCancellable

permissionsReadCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1332

permissionsReadEndpoint

permissionsReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:1344

permissionsTrace

permissionsTrace(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1273

permissionsTraceCancellable

permissionsTraceCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1293

permissionsTraceEndpoint

permissionsTraceEndpoint(): string
Returns string
- Defined in federation.ts:1305

permissionsUpdate

permissionsUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1390

permissionsUpdateCancellable

permissionsUpdateCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1414

permissionsUpdateEndpoint

permissionsUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:1426

setAccessTokenFn

setAccessTokenFn(fn: (() => undefined | string)): Federation
Parameters
- fn: (() => undefined | string)
  - - (): undefined | string
    - Returns undefined | string
Returns Federation
- Defined in federation.ts:57

setHeader

setHeader(name: string, value: undefined | string): Federation
Parameters
- name: string
- value: undefined | string
Returns Federation
- Defined in federation.ts:70

setHeaders

setHeaders(headers?: Headers): Federation
Parameters
- Optional headers: Headers
Returns Federation
- Defined in federation.ts:62

syncDataReadExposedAll

syncDataReadExposedAll(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1052

syncDataReadExposedAllCancellable

syncDataReadExposedAllCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1082

syncDataReadExposedAllEndpoint

syncDataReadExposedAllEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:1094

syncDataReadExposedInternal

syncDataReadExposedInternal(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1102

syncDataReadExposedInternalCancellable

syncDataReadExposedInternalCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1136

syncDataReadExposedInternalEndpoint

syncDataReadExposedInternalEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:1148

syncDataReadExposedSocial

syncDataReadExposedSocial(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1157

syncDataReadExposedSocialCancellable

syncDataReadExposedSocialCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1191

syncDataReadExposedSocialEndpoint

syncDataReadExposedSocialEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:1203

syncStructureReadExposedInternal

syncStructureReadExposedInternal(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:952

syncStructureReadExposedInternalCancellable

syncStructureReadExposedInternalCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:982

syncStructureReadExposedInternalEndpoint

syncStructureReadExposedInternalEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:994

syncStructureReadExposedSocial

syncStructureReadExposedSocial(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in federation.ts:1002

syncStructureReadExposedSocialCancellable

syncStructureReadExposedSocialCancellable(a: KV, extra?: AxiosRequestConfig<any>): {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}
- cancel: (() => void)
  - - (): void
    - Returns void
- response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)
  - - (a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
    - Parameters
      
      a: KV
      
      Optional extra: AxiosRequestConfig<any>
      Returns Promise<KV>
- Defined in federation.ts:1032

syncStructureReadExposedSocialEndpoint

syncStructureReadExposedSocialEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in federation.ts:1044

Class Federation

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: Ctor

Returns Federation

Properties

Protected Optional accessTokenFn

Type declaration

Returns undefined | string

Protected Optional baseURL

Protected headers

Methods

api

Returns AxiosInstance

manageStructureCreateExposed

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

manageStructureCreateExposedCancellable

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns { cancel: (() => void); response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>); }

cancel: (() => void)

Returns void

response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)

Parameters

a: KV

Optional extra: AxiosRequestConfig<any>

Returns Promise<KV>

manageStructureCreateExposedEndpoint

Parameters

a: KV

Returns string

manageStructureCreateMappings

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

manageStructureCreateMappingsCancellable

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns { cancel: (() => void); response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>); }

cancel: (() => void)

Returns void

response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)

Parameters

a: KV

Optional extra: AxiosRequestConfig<any>

Returns Promise<KV>

manageStructureCreateMappingsEndpoint

Parameters

a: KV

Returns string

manageStructureListAll

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

manageStructureListAllCancellable

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns { cancel: (() => void); response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>); }

cancel: (() => void)

Returns void

response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>)

Parameters

a: KV

Optional extra: AxiosRequestConfig<any>

Returns Promise<KV>

manageStructureListAllEndpoint

`Protected` `Optional` accessTokenFn

`Protected` `Optional` baseURL

`Protected` headers

Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}

`Optional` extra: AxiosRequestConfig<any>

Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}

`Optional` extra: AxiosRequestConfig<any>

Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}

`Optional` extra: AxiosRequestConfig<any>

Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}

`Optional` extra: AxiosRequestConfig<any>

Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}

`Optional` extra: AxiosRequestConfig<any>

Returns {
cancel: (() => void);
response: ((a: KV, extra?: AxiosRequestConfig<any>) => Promise<KV>);
}

`Optional` extra: AxiosRequestConfig<any>