Methods
addPersonImage
- addPersonImage(personId, image): Promise<[PersonImage, string]>
Returns Promise<[PersonImage, string]>
createGroup
- createGroup(name, params?): Promise<[PersonGroup, string]>
Parameters
- name: string
Optionalparams: {
metadata?: any;
}
Returns Promise<[PersonGroup, string]>
createPerson
- createPerson(name, params?): Promise<[Person, string]>
Parameters
- name: string
Optionalparams: {
groupIds?: string[];
metadata?: any;
}OptionalgroupIds?: string[]
Optionalmetadata?: any
Returns Promise<[Person, string]>
deleteGroup
- deleteGroup(groupId): Promise<[boolean, string]>
Returns Promise<[boolean, string]>
deletePerson
- deletePerson(personId): Promise<[boolean, string]>
Returns Promise<[boolean, string]>
deletePersonImage
- deletePersonImage(personId, imageId): Promise<[boolean, string]>
Parameters
- personId: string
- imageId: string
Returns Promise<[boolean, string]>
editPersonsInGroup
- editPersonsInGroup(groupId, request): Promise<[boolean, string]>
Returns Promise<[boolean, string]>
getGroup
- getGroup(groupId): Promise<[PersonGroup, string]>
Returns Promise<[PersonGroup, string]>
getPerson
- getPerson(personId): Promise<[Person, string]>
Returns Promise<[Person, string]>
getPersonGroupsForPage
- getPersonGroupsForPage(personId, page, size): Promise<[PageableItemList<PersonGroup>, string]>
Parameters
- personId: string
- page: number
- size: number
getPersonImage
- getPersonImage(personId, imageId): Promise<[string, string]>
Parameters
- personId: string
- imageId: string
Returns Promise<[string, string]>
getPersonImagesForPage
- getPersonImagesForPage(personId, page, size): Promise<[PageableItemList<PersonImage>, string]>
Parameters
- personId: string
- page: number
- size: number
getPersonsInGroup
- getPersonsInGroup(groupId): Promise<[PageableItemList<Person>, string]>
getPersonsInGroupForPage
- getPersonsInGroupForPage(groupId, page, size): Promise<[PageableItemList<Person>, string]>
Parameters
- groupId: string
- page: number
- size: number
searchPerson
- searchPerson(request): Promise<[SearchPerson[], string]>
Returns Promise<[SearchPerson[], string]>
updateGroup
- updateGroup(group): Promise<[boolean, string]>
Returns Promise<[boolean, string]>
updatePerson
- updatePerson(person): Promise<[boolean, string]>
Returns Promise<[boolean, string]>
Represents Regula Database layer and is the entry point for Person Database operations.