IModelBaseHandler Class

Beta

This class acts as the WsgClient for other iModelHub Handlers.

Extends

Extended by

Methods

Name Description
delete(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string): Promise<void> Send a delete request.  
deleteInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string, instance?: T, requestOptions?: WsgRequestOptions): Promise<void> Delete a strongly typed instance.  
formatContextIdForUrl(contextId: string): string    
getAgent(): any Get the agent used for imodelhub connection pooling.  
getCustomRequestOptions(): CustomRequestOptions 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    
getInstances<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, queryOptions?: RequestQueryOptions): Promise<T extends WsgInstance[]> Get multiple strongly typed instances.  
getRelyingPartyUrl(): string Protected Gets theRelyingPartyUrl for the service.  
getUrl(requestContext: ClientRequestContext): Promise<string> Get the URL of the service.  
getUrlSearchKey(): string Protected Get name/key to query the service URLs from the URL Discovery Service ("Buddi")  
postInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, instance: T extends WsgInstance, requestOptions?: WsgRequestOptions): Promise<T extends WsgInstance> 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[]> Post multiple strongly typed instances.  
postQuery<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, queryOptions: RequestQueryOptions): Promise<T extends WsgInstance[]> Get multiple strongly typed instances.  
setupOptionDefaults(options: RequestOptions): Promise<void> Protected Augment request options with defaults returned by the DefaultIModelHubRequestOptionsProvider.  

Properties

Name Type Description
_agent Protected any    
_fileHandler Protected FileHandler | undefined    
_url Protected undefined | string    
configRelyingPartyUri Static "imjs_imodelhub_relying_party_uri" = "imjs_imodelhub_relying_party_uri"    
searchKey Static string    

Inherited properties

Name Type Inherited from Description
apiVersion ConstructorProperty string WsgClient ApiVersion if the service supports it
configHostRelyingPartyUri Static "imjs_default_relying_party_uri" = "imjs_default_relying_party_uri" WsgClient  
configUseHostRelyingPartyUriAsFallback Static "imjs_use_default_relying_party_uri_as_fallback" = "imjs_use_default_relying_party_uri_as_fallback" WsgClient  

Defined in

Last Updated: 20 September, 2019