Package version:

Interface DeleteLargePersonGroupPerson

interface DeleteLargePersonGroupPerson {
    delete(options?): StreamableMethod<DeleteLargePersonGroupPerson200Response | DeleteLargePersonGroupPersonDefaultResponse>;
    get(options?): StreamableMethod<GetLargePersonGroupPerson200Response | GetLargePersonGroupPersonDefaultResponse>;
    patch(options?): StreamableMethod<UpdateLargePersonGroupPerson200Response | UpdateLargePersonGroupPersonDefaultResponse>;
}

Index

Methods

delete get patch

Methods

delete

delete(options?): StreamableMethod<DeleteLargePersonGroupPerson200Response | DeleteLargePersonGroupPersonDefaultResponse>
Delete an existing person from a Large 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<DeleteLargePersonGroupPerson200Response | DeleteLargePersonGroupPersonDefaultResponse>
- Defined in clientDefinitions.ts:1422

get

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

patch

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