Class PersonDatabase

Represents Regula Database layer and is the entry point for Person Database operations.

Methods

addPersonImage

addPersonImage(
personId: string,
image: ImageUpload,
): Promise<[PersonImage | null, string | null]>
Parameters
- personId: string
- image: ImageUpload
Returns Promise<[PersonImage | null, string | null]>
- Defined in person_database/person_database.d.ts:28

createGroup

createGroup(
name: string,
options?: { metadata?: any },
): Promise<[PersonGroup | null, string | null]>
Parameters
- name: string
- Optionaloptions: { metadata?: any }
Returns Promise<[PersonGroup | null, string | null]>
- Defined in person_database/person_database.d.ts:51

createPerson

createPerson(
name: string,
options?: { groupIds?: string[]; metadata?: any },
): Promise<[Person | null, string | null]>
Parameters
- name: string
- Optionaloptions: { groupIds?: string[]; metadata?: any }
Returns Promise<[Person | null, string | null]>
- Defined in person_database/person_database.d.ts:14

deleteGroup

deleteGroup(groupId: string): Promise<[boolean, string | null]>
Parameters
- groupId: string
Returns Promise<[boolean, string | null]>
- Defined in person_database/person_database.d.ts:65

deletePerson

deletePerson(personId: string): Promise<[boolean, string | null]>
Parameters
- personId: string
Returns Promise<[boolean, string | null]>
- Defined in person_database/person_database.d.ts:24

deletePersonImage

deletePersonImage(
personId: string,
imageId: string,
): Promise<[boolean, string | null]>
Parameters
- personId: string
- imageId: string
Returns Promise<[boolean, string | null]>
- Defined in person_database/person_database.d.ts:33

editPersonsInGroup

editPersonsInGroup(
groupId: string,
request: EditGroupPersonsRequest,
): Promise<[boolean, string | null]>
Parameters
- groupId: string
- request: EditGroupPersonsRequest
Returns Promise<[boolean, string | null]>
- Defined in person_database/person_database.d.ts:60

getGroup

getGroup(groupId: string): Promise<[PersonGroup | null, string | null]>
Parameters
- groupId: string
Returns Promise<[PersonGroup | null, string | null]>
- Defined in person_database/person_database.d.ts:67

getGroups

getGroups(): Promise<[PageableItemList<PersonGroup>, string | null]>
Returns Promise<[PageableItemList<PersonGroup>, string | null]>
- Defined in person_database/person_database.d.ts:69

getGroupsForPage

getGroupsForPage(
page: number,
size: number,
): Promise<[PageableItemList<PersonGroup>, string | null]>
Parameters
- page: number
- size: number
Returns Promise<[PageableItemList<PersonGroup>, string | null]>
- Defined in person_database/person_database.d.ts:71

getPerson

getPerson(personId: string): Promise<[Person | null, string | null]>
Parameters
- personId: string
Returns Promise<[Person | null, string | null]>
- Defined in person_database/person_database.d.ts:26

getPersonGroups

getPersonGroups(
personId: string,
): Promise<[PageableItemList<PersonGroup>, string | null]>
Parameters
- personId: string
Returns Promise<[PageableItemList<PersonGroup>, string | null]>
- Defined in person_database/person_database.d.ts:76

getPersonGroupsForPage

getPersonGroupsForPage(
    personId: string,
    page: number,
    size: number,
): Promise<[PageableItemList<PersonGroup>, string | null]>
Parameters
- personId: string
- page: number
- size: number
Returns Promise<[PageableItemList<PersonGroup>, string | null]>
- Defined in person_database/person_database.d.ts:78

getPersonImage

getPersonImage(
personId: string,
imageId: string,
): Promise<[string | null, string | null]>
Parameters
- personId: string
- imageId: string
Returns Promise<[string | null, string | null]>
- Defined in person_database/person_database.d.ts:38

getPersonImages

getPersonImages(
personId: string,
): Promise<[PageableItemList<PersonImage>, string | null]>
Parameters
- personId: string
Returns Promise<[PageableItemList<PersonImage>, string | null]>
- Defined in person_database/person_database.d.ts:43

getPersonImagesForPage

getPersonImagesForPage(
    personId: string,
    page: number,
    size: number,
): Promise<[PageableItemList<PersonImage>, string | null]>
Parameters
- personId: string
- page: number
- size: number
Returns Promise<[PageableItemList<PersonImage>, string | null]>
- Defined in person_database/person_database.d.ts:45

getPersonsInGroup

getPersonsInGroup(
groupId: string,
): Promise<[PageableItemList<Person>, string | null]>
Parameters
- groupId: string
Returns Promise<[PageableItemList<Person>, string | null]>
- Defined in person_database/person_database.d.ts:84

getPersonsInGroupForPage

getPersonsInGroupForPage(
    groupId: string,
    page: number,
    size: number,
): Promise<[PageableItemList<Person>, string | null]>
Parameters
- groupId: string
- page: number
- size: number
Returns Promise<[PageableItemList<Person>, string | null]>
- Defined in person_database/person_database.d.ts:86

searchPerson

searchPerson(
request: SearchPersonRequest,
): Promise<[SearchPerson[] | null, string | null]>
Parameters
- request: SearchPersonRequest
Returns Promise<[SearchPerson[] | null, string | null]>
- Defined in person_database/person_database.d.ts:92

updateGroup

updateGroup(group: PersonGroup): Promise<[boolean, string | null]>
Parameters
- group: PersonGroup
Returns Promise<[boolean, string | null]>
- Defined in person_database/person_database.d.ts:58

updatePerson

updatePerson(person: Person): Promise<[boolean, string | null]>
Parameters
- person: Person
Returns Promise<[boolean, string | null]>
- Defined in person_database/person_database.d.ts:22