Options
All
  • Public
  • Public/Protected
  • All
Menu

@entaconsulting/rpaforms-connect-sdk

Index

Namespaces

Type aliases

Functions

Type aliases

AuthenticationOptions

AuthenticationOptions: SdkAuthenticationOptions | DelegatedAuthenticationOptions

AuthenticationType

AuthenticationType: "AAD" | "B2C"

CreateFormInstanceResult

CreateFormInstanceResult: { formInstanceId: string; formInstanceToken: string; formInstanceUri: string }

Type declaration

  • formInstanceId: string
  • formInstanceToken: string
  • formInstanceUri: string

DelegatedAuthenticationOptions

DelegatedAuthenticationOptions: { authType: AuthenticationType; username: string; getToken: any }

Type declaration

  • authType: AuthenticationType
  • username: string
  • getToken:function
    • getToken(): Promise<undefined | string>

    • Returns Promise<undefined | string>

FormDefinition

FormDefinition: { canCreate: boolean; canViewOwnedInstancesOnly: boolean; description?: string; disabled: boolean; displayDescription?: string; displayName?: string; formDefinitionId: string; name: string }

Type declaration

  • canCreate: boolean
  • canViewOwnedInstancesOnly: boolean
  • Optional description?: string
  • disabled: boolean
  • Optional displayDescription?: string
  • Optional displayName?: string
  • formDefinitionId: string
  • name: string

FormDefinitionInfo

FormDefinitionInfo: { description?: string; formDefinitionId: string; name: string; processInfoTags?: string[]; tags?: string[] }

Type declaration

  • Optional description?: string
  • formDefinitionId: string
  • name: string
  • Optional processInfoTags?: string[]
  • Optional tags?: string[]

FormInstanceInfo

FormInstanceInfo: { createdAt: string; createdBy: string; id: string; lastSaved: string; name: string; processInfo: FormInstanceProcessInfo; state: string; title: string }

Type declaration

  • createdAt: string
  • createdBy: string
  • id: string
  • lastSaved: string
  • name: string
  • processInfo: FormInstanceProcessInfo
  • state: string
  • title: string

FormInstanceListResult

FormInstanceListResult: { continuationToken: string | null; result: FormInstanceInfo[] }

Type declaration

FormInstanceProcessInfo

FormInstanceProcessInfo: { completionMessage: string | null; endState: FormInstanceProcessInfoEndState; status: string | null; tags?: Record<string, string>; updatedAt: string }

Type declaration

FormInstanceProcessInfoEndState

FormInstanceProcessInfoEndState: "OK" | "Error" | null

FormInstanceQueryOptions

FormInstanceQueryOptions: { continuationToken?: string | null; filter?: FormInstanceQueryOptionsFilter; formDefinitionId: string; maxItemCount?: number; orderByDirection?: string; orderByField?: string }

Type declaration

  • Optional continuationToken?: string | null
  • Optional filter?: FormInstanceQueryOptionsFilter
  • formDefinitionId: string
  • Optional maxItemCount?: number
  • Optional orderByDirection?: string
  • Optional orderByField?: string

FormInstanceQueryOptionsFilter

FormInstanceQueryOptionsFilter: { createdAtFrom?: Date; createdAtTo?: Date; createdBy?: string; lastSavedFrom?: Date; lastSavedTo?: Date; processInfoCompletionMessage?: string; processInfoEndState?: string; processInfoStatus?: string; processInfoTags?: Record<string, string>; processInfoUpdatedAtFrom?: Date; processInfoUpdatedAtTo?: Date; state?: string; tags?: Record<string, string>; title?: string }

Type declaration

  • Optional createdAtFrom?: Date
  • Optional createdAtTo?: Date
  • Optional createdBy?: string
  • Optional lastSavedFrom?: Date
  • Optional lastSavedTo?: Date
  • Optional processInfoCompletionMessage?: string
  • Optional processInfoEndState?: string
  • Optional processInfoStatus?: string
  • Optional processInfoTags?: Record<string, string>
  • Optional processInfoUpdatedAtFrom?: Date
  • Optional processInfoUpdatedAtTo?: Date
  • Optional state?: string
  • Optional tags?: Record<string, string>
  • Optional title?: string

FormInstanceType

FormInstanceType: "formInstance" | "stageInstance"

RpaFormsSdkConfiguration

RpaFormsSdkConfiguration: Exclude<RpaFormsSdkConfigurationOptions, "authentication"> & { authentication: Required<AuthenticationOptions> }

RpaFormsSdkConfigurationOptions

RpaFormsSdkConfigurationOptions: { authentication: AuthenticationOptions; publicFillUrl?: string; serviceUrl?: string }

Type declaration

SdkAuthenticationOptions

SdkAuthenticationOptions: { appIdURI?: string; authority: string; clientId: string; redirectUri: string }

Type declaration

  • Optional appIdURI?: string
  • authority: string
  • clientId: string
  • redirectUri: string

StageInfo

StageInfo: { formDefinitionName: string; formInstanceId: string; formTitle: string; stageCreatedAt: string; stageInstanceId: string; stageLastSaved: string; stageName: string; stageState: string; type?: FormInstanceType }

Type declaration

  • formDefinitionName: string
  • formInstanceId: string
  • formTitle: string
  • stageCreatedAt: string
  • stageInstanceId: string
  • stageLastSaved: string
  • stageName: string
  • stageState: string
  • Optional type?: FormInstanceType

StageListResult

StageListResult: { continuationToken: string | null; result: StageInfo[] }

Type declaration

  • continuationToken: string | null
  • result: StageInfo[]

StageQueryOptions

StageQueryOptions: { continuationToken?: string | null; filter?: StageQueryOptionsFilter; formDefinitionId?: string; maxItemCount?: number; orderByDirection?: string; orderByField?: string }

Type declaration

  • Optional continuationToken?: string | null
  • Optional filter?: StageQueryOptionsFilter
  • Optional formDefinitionId?: string
  • Optional maxItemCount?: number
  • Optional orderByDirection?: string
  • Optional orderByField?: string

StageQueryOptionsFilter

StageQueryOptionsFilter: { createdAtFrom?: Date; createdAtTo?: Date; formDefinitionId?: string; formDefinitionName?: string; lastSavedFrom?: Date; lastSavedTo?: Date; stageName?: string; state?: string; title?: string }

Type declaration

  • Optional createdAtFrom?: Date
  • Optional createdAtTo?: Date
  • Optional formDefinitionId?: string
  • Optional formDefinitionName?: string
  • Optional lastSavedFrom?: Date
  • Optional lastSavedTo?: Date
  • Optional stageName?: string
  • Optional state?: string
  • Optional title?: string

Functions

initialize

isDelegatedAuthentictionOptions

Generated using TypeDoc