/** @packageDocumentation * @module iTwinServiceClients */ import { AuthorizedClientRequestContext } from "./AuthorizedClientRequestContext"; import { WsgInstance } from "./ECJsonTypeMap"; import { RequestQueryOptions } from "./Request"; import { WsgClient, WsgRequestOptions } from "./WsgClient"; /** Content */ export declare class Content extends WsgInstance { filter?: string; groupLabel?: string; isShared?: boolean; module?: string; moduleVersion?: string; name?: string; projectId?: string; createdDate?: string; updatedDate?: string; parentId?: string; owner?: string; dataId?: string; isDeleted?: boolean; } /** * Client wrapper to Reality Data Service */ export declare class BIMReviewShareClient extends WsgClient { static readonly searchKey: string; static readonly configURL = "imjs_bim_review_share_url"; static readonly configRelyingPartyUri = "imjs_bim_review_share_relying_party_uri"; static readonly configRegion = "imjs_bim_review_share_region"; /** * Creates an instance of RealityDataServicesClient. */ constructor(); private byteCount; /** BIM Review Share functionality to post an instance and data * Not REST-ful, they treat 308 differently without returning a redirect location * However, this is handled by this call to act as expected by the service * @param requestContext The client request context * @param typedConstructor Used by clients to post a strongly typed instance through the REST API that's expected to return a standard response. * @param relativeUrlPath Relative path to the REST resource. * @param instance Strongly typed instance to be posted. * @param data JSON string that will be sent in second request for posting the data of the content * @param requestOptions WSG options for the request. * @returns The posted instance that's returned back from the server. */ private postInstanceAndData; /** * Used by clients to get strongly typed instances from standard WSG REST queries that return EC JSON instances. * @param requestContext The client request context * @param relativeUrlPath Relative path to the REST resource. * @param queryOptions Query options. * @returns Array of strongly typed instances. */ private getBlob; /** * Post content to BIM Review Share * @param requestContext The client request context * @param filter Filter property in content, defines the name of the iModel that relates to this content * @param groupLabel GroupLabel property in content * @param module Module property (e.g. 'DataViz') * @param moduleVersion Module version string (e.g. 1.0.0) * @param name User-defined name of data (e.g. 'My Saved View 1') * @param owner Id of the user that owns this content * @param projectId Project ID that this content refers to * @param data JSON string with the data that wants to be saved * @param instanceId Wsg Instance Id if updating the instance instead of creating a new one */ postContent(requestContext: AuthorizedClientRequestContext, filter: string, groupLabel: string, module: string, moduleVersion: string, name: string, owner: string, projectId: string, data: any, instanceId?: string): Promise; /** * Updates the data of an already existing instance using a retrieved Content * @param requestContext The client request context * @param content instance of the Content * @param data updated data */ updateContent(requestContext: AuthorizedClientRequestContext, content: Content, data: any): Promise; /** * Get all content instances * @param requestContext The client request context * @param projectId Id of the project to get the instances from * @param module Name of the module (e.g. 'DataViz') */ getContentInstances(requestContext: AuthorizedClientRequestContext, projectId: string, module: string, owner?: string): Promise; /** * Get an instance of a Content * @param requestContext The client request context * @param projectId Project Id where the content resides * @param moduleName Module name of the content (e.g. 'DataViz') * @param instanceId Instance Id of the Content * @param queryOptions Query options for filtering */ getContentInstance(requestContext: AuthorizedClientRequestContext, projectId: string, moduleName: string, instanceId: string, queryOptions?: RequestQueryOptions): Promise; /** * Deletes a content instance * @param requestContext The client request context * @param content Content instance * @param options WsgRequestOptions optional */ deleteContentInstance(requestContext: AuthorizedClientRequestContext, content: Content, options?: WsgRequestOptions): Promise; /** * Gets the data related to an instance of a Content * @param requestContext The client request context * @param instanceId Instance Id of the Content instance * @param queryOptions Query options for filtering */ getContentData(requestContext: AuthorizedClientRequestContext, instanceId: string, queryOptions?: RequestQueryOptions): Promise; /** * Gets name/key to query the service URLs from the URL Discovery Service ("Buddi") * @returns Search key for the URL. */ protected getUrlSearchKey(): string; /** * Gets the default URL for the service. * @returns Default URL for the service. */ protected getDefaultUrl(): string; /** * Override default region for this service * @returns region id or undefined */ protected getRegion(): number | undefined; /** * Gets theRelyingPartyUrl for the service. * @returns RelyingPartyUrl for the service. */ protected getRelyingPartyUrl(): string; } //# sourceMappingURL=BIMReviewShareClient.d.ts.map