Class Federation

Hierarchy

Federation

Index

Constructors

Properties

accessTokenFn? baseURL? headers

Methods

api manageStructureCreateExposed manageStructureCreateExposedEndpoint manageStructureCreateMappings manageStructureCreateMappingsEndpoint manageStructureListAll manageStructureListAllEndpoint manageStructureReadExposed manageStructureReadExposedEndpoint manageStructureReadMappings manageStructureReadMappingsEndpoint manageStructureReadShared manageStructureReadSharedEndpoint manageStructureRemoveExposed manageStructureRemoveExposedEndpoint manageStructureUpdateExposed manageStructureUpdateExposedEndpoint nodeCreate nodeCreateEndpoint nodeDelete nodeDeleteEndpoint nodeGenerateUri nodeGenerateUriEndpoint nodeHandshakeComplete nodeHandshakeCompleteEndpoint nodeHandshakeConfirm nodeHandshakeConfirmEndpoint nodeHandshakeInitialize nodeHandshakeInitializeEndpoint nodePair nodePairEndpoint nodeRead nodeReadEndpoint nodeSearch nodeSearchEndpoint nodeUndelete nodeUndeleteEndpoint nodeUpdate nodeUpdateEndpoint permissionsDelete permissionsDeleteEndpoint permissionsEffective permissionsEffectiveEndpoint permissionsList permissionsListEndpoint permissionsRead permissionsReadEndpoint permissionsTrace permissionsTraceEndpoint permissionsUpdate permissionsUpdateEndpoint setAccessTokenFn setHeader setHeaders syncDataReadExposedAll syncDataReadExposedAllEndpoint syncDataReadExposedInternal syncDataReadExposedInternalEndpoint syncDataReadExposedSocial syncDataReadExposedSocialEndpoint syncStructureReadExposedInternal syncStructureReadExposedInternalEndpoint syncStructureReadExposedSocial syncStructureReadExposedSocialEndpoint

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:446

manageStructureCreateExposedEndpoint

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

manageStructureCreateMappings

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

manageStructureCreateMappingsEndpoint

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

manageStructureListAll

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

manageStructureListAllEndpoint

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

manageStructureReadExposed

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

manageStructureReadExposedEndpoint

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

manageStructureReadMappings

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

manageStructureReadMappingsEndpoint

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

manageStructureReadShared

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

manageStructureReadSharedEndpoint

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

manageStructureRemoveExposed

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

manageStructureRemoveExposedEndpoint

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

manageStructureUpdateExposed

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

manageStructureUpdateExposedEndpoint

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

nodeCreate

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

nodeCreateEndpoint

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

nodeDelete

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

nodeDeleteEndpoint

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

nodeGenerateUri

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

nodeGenerateUriEndpoint

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

nodeHandshakeComplete

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

nodeHandshakeCompleteEndpoint

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

nodeHandshakeConfirm

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

nodeHandshakeConfirmEndpoint

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

nodeHandshakeInitialize

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

nodeHandshakeInitializeEndpoint

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

nodePair

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

nodePairEndpoint

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

nodeRead

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

nodeReadEndpoint

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

nodeSearch

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

nodeSearchEndpoint

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

nodeUndelete

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

nodeUndeleteEndpoint

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

nodeUpdate

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

nodeUpdateEndpoint

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

permissionsDelete

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

permissionsDeleteEndpoint

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

permissionsEffective

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

permissionsEffectiveEndpoint

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

permissionsList

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

permissionsListEndpoint

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

permissionsRead

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

permissionsReadEndpoint

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

permissionsTrace

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

permissionsTraceEndpoint

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

permissionsUpdate

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

permissionsUpdateEndpoint

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

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:800

syncDataReadExposedAllEndpoint

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

syncDataReadExposedInternal

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

syncDataReadExposedInternalEndpoint

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

syncDataReadExposedSocial

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

syncDataReadExposedSocialEndpoint

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

syncStructureReadExposedInternal

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

syncStructureReadExposedInternalEndpoint

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

syncStructureReadExposedSocial

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

syncStructureReadExposedSocialEndpoint

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