getContentDescriptor Method

Overloads
getContentDescriptor(requestOptions)  
getContentDescriptor(requestOptions, displayType, keys, selection) Deprecated  

getContentDescriptor(requestOptions)

getContentDescriptor(requestOptions: ContentDescriptorRequestOptions<IModelConnection, KeySet, RulesetVariable>): Promise<undefined | Descriptor>

Parameter Type Description
requestOptions ContentDescriptorRequestOptions<IModelConnection, KeySet, RulesetVariable>  

Returns - Promise<undefined | Descriptor>



getContentDescriptor(requestOptions, displayType, keys, selection)

Deprecated  Use an overload with ContentDescriptorRequestOptions

Retrieves the content descriptor which describes the content and can be used to customize it.

getContentDescriptor(requestOptions: ContentRequestOptions<IModelConnection, RulesetVariable>, displayType: string, keys: KeySet, selection: undefined | SelectionInfo): Promise<undefined | Descriptor>

Parameter Type Description
requestOptions ContentRequestOptions<IModelConnection, RulesetVariable>  
displayType string  
keys KeySet  
selection undefined | SelectionInfo  

Returns - Promise<undefined | Descriptor>


Defined in

Last Updated: 11 June, 2024