ExtensionClient Class

Beta  

Client for querying, publishing and deleting iModel.js Extensions.

The imodel-extension-service-api OIDC scope is required for all operations and the imodel-extension-service:modify is required for modification operations (modify, publish, and deleting).

Extends

Methods

Name Description
constructor(): ExtensionClient    
deleteExtension(requestContext: AuthorizedClientRequestContext, contextId: string, extensionName: string, version?: string): Promise<void> Deletes an extension from extension service  
downloadExtension(requestContext: AuthorizedClientRequestContext, contextId: string, extensionName: string, version: string): Promise<ExtensionFile[]> Downloads an extension  
getExtensionProps(requestContext: AuthorizedClientRequestContext, contextId: string, extensionName: string, version: string): Promise<undefined | ExtensionProps> Gets information about an extension's specific version  
getExtensions(requestContext: AuthorizedClientRequestContext, contextId: string, extensionName?: string): Promise<ExtensionProps[]> Gets information on extensions.  
getUrl(requestContext: ClientRequestContext): Promise<string>    

Inherited methods

Name Inherited from Description
applyUserConfiguredHttpRequestOptions(requestOptions: RequestOptions, userDefinedRequestOptions?: HttpRequestOptions): void Protected Client Configures request options based on user defined values in HttpRequestOptions
delete(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string, httpRequestOptions?: HttpRequestOptions): Promise<void> Protected Client used by clients to send delete requests
setupOptionDefaults(options: RequestOptions): Promise<void> Protected Client Augments request options with defaults returned by the DefaultRequestOptionsProvider.

Inherited properties

Name Type Inherited from Description
_url Protected undefined | string Client  
baseUrl Protected undefined | string Client Sets the default base URL to use with this client.

Defined in

Last Updated: 12 June, 2024