getContentDescriptor Method

Retrieves the content descriptor which can be used to get content.

getContentDescriptor(requestContext: ClientRequestContext, requestOptions: ContentRequestOptions<IModelDb>, displayType: string, keys: KeySet, selection: SelectionInfo | undefined): Promise<Descriptor | undefined>

Parameter Type Description
requestContext ClientRequestContext The client request context
requestOptions ContentRequestOptions<IModelDb> options for the request
displayType string The preferred display type of the return content.
keys KeySet Keys of ECInstances to get the content for.
selection SelectionInfo | undefined Optional selection info in case the content is being requested due to selection change.

Returns - Promise<Descriptor | undefined>

A promise object that returns either a descriptor on success or an error string on error.

Defined in

Last Updated: 13 June, 2024