Package version:

Interface DeletePersonGroupPerson

interface DeletePersonGroupPerson {
    delete(options?): StreamableMethod<DeletePersonGroupPerson200Response | DeletePersonGroupPersonDefaultResponse>;
    get(options?): StreamableMethod<GetPersonGroupPerson200Response | GetPersonGroupPersonDefaultResponse>;
    patch(options?): StreamableMethod<UpdatePersonGroupPerson200Response | UpdatePersonGroupPersonDefaultResponse>;
}

Index

Methods

delete get patch

Methods

delete

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

get

get(options?): StreamableMethod<GetPersonGroupPerson200Response | GetPersonGroupPersonDefaultResponse>
Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature(s).
Parameters
- Optional options: any
Returns StreamableMethod<GetPersonGroupPerson200Response | GetPersonGroupPersonDefaultResponse>
- Defined in clientDefinitions.ts:1242

patch

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