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

Name Type Inherited from Description
_agent Protected any IModelBaseHandler  
_fileHandler Protected FileHandler | undefined IModelBaseHandler  
_url Protected undefined | string IModelBaseHandler  
apiVersion ConstructorProperty string WsgClient ApiVersion if the service supports it
configHostRelyingPartyUri Static "imjs_default_relying_party_uri" = "imjs_default_relying_party_uri" WsgClient  
configRelyingPartyUri Static "imjs_imodelhub_relying_party_uri" = "imjs_imodelhub_relying_party_uri" IModelBaseHandler  
configUseHostRelyingPartyUriAsFallback Static "imjs_use_default_relying_party_uri_as_fallback" = "imjs_use_default_relying_party_uri_as_fallback" WsgClient  
searchKey Static string IModelBaseHandler  

Defined in

Last Updated: 20 September, 2019