Package version:

Interface DeletePerson

interface DeletePerson {
    delete(options?): StreamableMethod<DeletePerson202Response | DeletePersonDefaultResponse>;
    get(options?): StreamableMethod<GetPerson200Response | GetPersonDefaultResponse>;
    patch(options?): StreamableMethod<UpdatePerson200Response | UpdatePersonDefaultResponse>;
}

Index

Methods

delete get patch

Methods

delete

delete(options?): StreamableMethod<DeletePerson202Response | DeletePersonDefaultResponse>
Delete an existing person from Person Directory. The persistedFaceId(s), userData, person name and face feature(s) in the person entry will all be deleted.
Parameters
- Optional options: any
Returns StreamableMethod<DeletePerson202Response | DeletePersonDefaultResponse>
- Defined in clientDefinitions.ts:938

get

get(options?): StreamableMethod<GetPerson200Response | GetPersonDefaultResponse>
Retrieve a person's name and userData from Person Directory.
Parameters
- Optional options: any
Returns StreamableMethod<GetPerson200Response | GetPersonDefaultResponse>
- Defined in clientDefinitions.ts:942

patch

patch(options?): StreamableMethod<UpdatePerson200Response | UpdatePersonDefaultResponse>
Update name or userData of a person.
Parameters
- Optional options: any
Returns StreamableMethod<UpdatePerson200Response | UpdatePersonDefaultResponse>
- Defined in clientDefinitions.ts:946