IModelBankHandler Class
Beta
This class acts as the WsgClient for other iModelBank Handlers.
Extends
Methods
Name |
Description |
|
constructor(url: string, handler: FileHandler | undefined, keepAliveDuration: number = 30000): IModelBankHandler |
Creates an instance of IModelBankWsgClient. |
|
getUrl(_requestContext: ClientRequestContext, excludeApiVersion?: false | true): Promise<string> |
|
|
getUrlSearchKey(): string Protected |
|
|
Inherited methods
Name |
Inherited from |
Description |
delete(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string): Promise<void> |
IModelBaseHandler |
Send a delete request. |
deleteInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string, instance?: T, requestOptions?: WsgRequestOptions): Promise<void> |
IModelBaseHandler |
Delete a strongly typed instance. |
formatContextIdForUrl(contextId: string): string |
IModelBaseHandler |
|
getAgent(): any |
IModelBaseHandler |
Get the agent used for imodelhub connection pooling. |
getCustomRequestOptions(): CustomRequestOptions |
IModelBaseHandler |
Get an instance of CustomRequestOptions, which can be used to set custom request parameters for all future requests made by this handler. |
getFileHandler(): FileHandler | undefined |
IModelBaseHandler |
|
getInstances<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, queryOptions?: RequestQueryOptions): Promise<T extends WsgInstance[]> |
IModelBaseHandler |
Get multiple strongly typed instances. |
getRelyingPartyUrl(): string Protected |
IModelBaseHandler |
Gets theRelyingPartyUrl for the service. |
postInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, instance: T extends WsgInstance, requestOptions?: WsgRequestOptions): Promise<T extends WsgInstance> |
IModelBaseHandler |
Post a strongly typed instance. |
postInstances<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, instances: T extends WsgInstance[], requestOptions?: WsgRequestOptions): Promise<T extends WsgInstance[]> |
IModelBaseHandler |
Post multiple strongly typed instances. |
postQuery<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, queryOptions: RequestQueryOptions): Promise<T extends WsgInstance[]> |
IModelBaseHandler |
Get multiple strongly typed instances. |
setupOptionDefaults(options: RequestOptions): Promise<void> Protected |
IModelBaseHandler |
Augment request options with defaults returned by the DefaultIModelHubRequestOptionsProvider. |
Inherited properties
Defined in
Last Updated:
08 January, 2020