BS2_GetUserOverride [BioStar Device SDK ]

This is an old revision of the document!

User Management API > BS2_GetUserOverride

This feature allows doors to remain open longer than the standard open time for users who need more time for access, such as people with disabilities or delivery personnel.
Set the extended open time for the door through extendedAutoLockTimeout in BS2Door, and specify users to whom the extended open time will apply through BS2UserOverride.
When using extended open time, the following rules apply:
* When users with and without extended open time authenticate consecutively, the open time is applied based on the last authenticated user.
* When using two-step authentication, if at least one authenticated user is subject to extended open time, the door opens with the extended open time.

[+ 2.9.12] Gets user information using extended door open time by specifying user IDs.

Declaration

#include "BS_API.h"
 
int BS2_GetUserOverride(void* context, BS2_DEVICE_ID deviceId, const char* userIDs, uint32_t numOfUsers, BS2UserOverride** overrideObjs, uint32_t* numOfOverrides);

View BS2UserOverride structure

Parameters

[In] context : Context
[In] deviceId : Device ID
[In] userIDs : Specifies user IDs to query
[In] numOfUsers : Number of users to query
[Out] overrideObjs : Pointer to store user information using extended door open time
[Out] numOfOverrides : Pointer to store the number of acquired users

Return Value

Returns BS_SDK_SUCCESS when performed successfully, and returns the corresponding error code when failed.