ContextRegistryClient Class

Beta  

Client API to access the context registry services.

Extends

Methods

Name Description
constructor(): ContextRegistryClient    
getAsset(requestContext: AuthorizedClientRequestContext, queryOptions?: RequestQueryOptions): Promise<Asset> Gets a specific iTwin asset context.  
getAssets(requestContext: AuthorizedClientRequestContext, queryOptions?: RequestQueryOptions): Promise<Asset[]> Gets the iTwin asset contexts that are accessible to the authorized user.  
getInvitedProjects(requestContext: AuthorizedClientRequestContext, queryOptions?: ContextRegistryRequestQueryOptions): Promise<Project[]> Get the iTwin projects that the user has been "invited" to.  
getProject(requestContext: AuthorizedClientRequestContext, queryOptions?: ContextRegistryRequestQueryOptions): Promise<Project> Gets a specific iTwin project context.  
getProjects(requestContext: AuthorizedClientRequestContext, queryOptions?: ContextRegistryRequestQueryOptions): Promise<Project[]> Gets the iTwin project contexts that are accessible to the authorized user.  
getRelyingPartyUrl(): string Protected Gets theRelyingPartyUrl for the service.  
getTeam(requestContext: AuthorizedClientRequestContext): Promise<Team> Gets the iTwin team context that the authorized user belongs to.  
setupOptionDefaults(options: RequestOptions): Promise<void> Protected    

Inherited methods

Name Inherited from Description
applyUserConfiguredHttpRequestOptions(requestOptions: RequestOptions, userDefinedRequestOptions?: HttpRequestOptions): void Protected WsgClient Configures request options based on user defined values in HttpRequestOptions
delete(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string, httpRequestOptions?: HttpRequestOptions): Promise<void> Protected WsgClient used by clients to send delete requests
deleteInstance<T extends WsgInstance<T>>(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string, instance?: T, requestOptions?: WsgRequestOptions, httpRequestOptions?: HttpRequestOptions): Promise<void> Protected WsgClient used by clients to delete strongly typed instances through the standard WSG REST API
getInstances<T extends WsgInstance<T>>(requestContext: AuthorizedClientRequestContext, typedConstructor: () => T, relativeUrlPath: string, queryOptions?: RequestQueryOptions, httpRequestOptions?: HttpRequestOptions): Promise<T[]> Protected WsgClient Used by clients to get strongly typed instances from standard WSG REST queries that return EC JSON instances.
getInstancesChunk<T extends WsgInstance<T>>(requestContext: AuthorizedClientRequestContext, url: string, chunkedQueryContext: undefined | ChunkedQueryContext, typedConstructor: () => T, queryOptions?: RequestQueryOptions, httpRequestOptions?: HttpRequestOptions): Promise<T[]> Protected WsgClient Used by clients to get a chunk of strongly typed instances from standard WSG REST queries that return EC JSON instances.
getUrl(requestContext: ClientRequestContext, excludeApiVersion?: boolean): Promise<string> WsgClient Gets the URL of the service.
postInstance<T extends WsgInstance<T>>(requestContext: AuthorizedClientRequestContext, typedConstructor: () => T, relativeUrlPath: string, instance: T, requestOptions?: WsgRequestOptions, httpRequestOptions?: HttpRequestOptions): Promise<T> Protected WsgClient Used by clients to post strongly typed instances through standard WSG REST API
postInstances<T extends WsgInstance<T>>(requestContext: AuthorizedClientRequestContext, typedConstructor: () => T, relativeUrlPath: string, instances: T[], requestOptions?: WsgRequestOptions, httpRequestOptions?: HttpRequestOptions): Promise<T[]> Protected WsgClient Used by clients to post multiple strongly typed instances through standard WSG REST API
postQuery<T extends WsgInstance<T>>(requestContext: AuthorizedClientRequestContext, typedConstructor: () => T, relativeUrlPath: string, queryOptions: RequestQueryOptions, httpRequestOptions?: HttpRequestOptions): Promise<T[]> Protected WsgClient Used by clients to get strongly typed instances from standard WSG REST queries that return EC JSON instances.

Properties

Name Type Description
configRelyingPartyUri StaticReadonly "imjs_connected_context_service_relying_party_uri"    
searchKey StaticReadonly string    

Inherited properties

Name Type Inherited from Description
_url Protected undefined | string WsgClient  
apiVersion string WsgClient  
baseUrl Protected undefined | string WsgClient Sets the default base URL to use with this client.
configHostRelyingPartyUri StaticReadonly "imjs_default_relying_party_uri" WsgClient  
configUseHostRelyingPartyUriAsFallback StaticReadonly "imjs_use_default_relying_party_uri_as_fallback" WsgClient  

Defined in

Last Updated: 12 June, 2024