Skip to content

Interface: ProfileService ​

Defined in: domain/contracts.ts:625

Registry of document profiles.

Methods ​

getProfile() ​

ts
getProfile(profileId): Promise<DocumentProfile>;

Defined in: domain/contracts.ts:629

Returns a profile by id.

Parameters ​

ParameterType
profileIdstring

Returns ​

Promise<DocumentProfile>


listProfiles() ​

ts
listProfiles(): Promise<DocumentProfile[]>;

Defined in: domain/contracts.ts:627

Lists all registered profiles.

Returns ​

Promise<DocumentProfile[]>


registerProfile() ​

ts
registerProfile(input): Promise<void>;

Defined in: domain/contracts.ts:631

Registers a profile.

Parameters ​

ParameterType
input{ profile: DocumentProfile; }
input.profileDocumentProfile

Returns ​

Promise<void>