BIMReviewShareClient Class

Client wrapper to Reality Data Service

Extends

Methods

Name Description
constructor(): BIMReviewShareClient Creates an instance of RealityDataServicesClient.  
deleteContentInstance(requestContext: AuthorizedClientRequestContext, content: Content, options?: WsgRequestOptions): Promise<void> Deletes a content instance  
getContentData(requestContext: AuthorizedClientRequestContext, instanceId: string, queryOptions?: RequestQueryOptions): Promise<any> Gets the data related to an instance of a Content  
getContentInstance(requestContext: AuthorizedClientRequestContext, projectId: string, moduleName: string, instanceId: string, queryOptions?: RequestQueryOptions): Promise<Content[]> Get an instance of a Content  
getContentInstances(requestContext: AuthorizedClientRequestContext, projectId: string, module: string, owner?: string): Promise<Content[]> Get all content instances  
getDefaultUrl(): string Protected Gets the default URL for the service.  
getRegion(): number | undefined Protected Override default region for this service  
getRelyingPartyUrl(): string Protected Gets theRelyingPartyUrl for the service.  
getUrlSearchKey(): string Protected Gets name/key to query the service URLs from the URL Discovery Service ("Buddi")  
postContent(requestContext: AuthorizedClientRequestContext, filter: string, groupLabel: string, module: string, moduleVersion: string, name: string, owner: string, projectId: string, data: any, instanceId?: string): Promise<Content> Post content to BIM Review Share  
updateContent(requestContext: AuthorizedClientRequestContext, content: Content, data: any): Promise<Content> Updates the data of an already existing instance using a retrieved Content  

Inherited methods

Name Inherited from Description
delete(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string): Promise<void> Protected Client used by clients to send delete requests
deleteInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string, instance?: T, requestOptions?: WsgRequestOptions): Promise<void> Protected WsgClient used by clients to delete strongly typed instances through the standard WSG REST API
getInstances<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, queryOptions?: RequestQueryOptions): Promise<T extends WsgInstance[]> Protected WsgClient Used by clients to get strongly typed instances from standard WSG REST queries that return EC JSON instances.
getUrl(requestContext: ClientRequestContext, excludeApiVersion?: false | true): Promise<string> WsgClient Gets the URL of the service.
postInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, instance: T extends WsgInstance, requestOptions?: WsgRequestOptions): Promise<T extends WsgInstance> Protected WsgClient Used by clients to post strongly typed instances through standard WSG REST API
postInstances<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, instances: T extends WsgInstance[], requestOptions?: WsgRequestOptions): Promise<T extends WsgInstance[]> Protected WsgClient Used by clients to post multiple strongly typed instances through standard WSG REST API
postQuery<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, queryOptions: RequestQueryOptions): Promise<T extends WsgInstance[]> Protected WsgClient Used by clients to get strongly typed instances from standard WSG REST queries that return EC JSON instances.
setupOptionDefaults(options: RequestOptions): Promise<void> Protected WsgClient Augments request options with defaults returned by the DefaultWsgRequestOptionsProvider.

Properties

Name Type Description
configRegion Static "imjs_bim_review_share_region" = "imjs_bim_review_share_region"    
configRelyingPartyUri Static "imjs_bim_review_share_relying_party_uri" = "imjs_bim_review_share_relying_party_uri"    
configURL Static "imjs_bim_review_share_url" = "imjs_bim_review_share_url"    
searchKey Static string    

Inherited properties

Name Type Inherited from Description
_url Protected undefined | string WsgClient  
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