ConcurrencyControl.CodesManager Class

Beta  

Code manager. This class can be used to reserve Codes ahead of time and to query the status of Codes. See ConcurrencyControl.requestResources for how to reserve Codes as they are used.

Methods

Name Description
areAvailable(requestContext: AuthorizedClientRequestContext, codes: CodeProps[]): Promise<boolean> Check to see if all of the specified codes are available to be reserved. Beta  
isReserved(code: CodeProps): boolean Returns true if the specified code has been reserved by this briefcase. Beta  
query(requestContext: AuthorizedClientRequestContext, specId: string, scopeId: string, value?: string): Promise<HubCode[]> Queries the state of the specified Codes in the code service.  
reserve(requestContext: AuthorizedClientRequestContext, codes?: CodeProps[]): Promise<void> Reserve Codes.  

Defined in

Last Updated: 12 June, 2024