getDisplayLabelDefinition Method

Overloads
getDisplayLabelDefinition(requestOptions)  
getDisplayLabelDefinition(requestContext, requestOptions, key) Deprecated  

getDisplayLabelDefinition(requestOptions)

Retrieves display label definition of specific item

getDisplayLabelDefinition(requestOptions: WithClientRequestContext<DisplayLabelRequestOptions<IModelDb, InstanceKey>>): Promise<LabelDefinition>

Parameter Type Description
requestOptions WithClientRequestContext<DisplayLabelRequestOptions<IModelDb, InstanceKey>>  

Returns - Promise<LabelDefinition>



getDisplayLabelDefinition(requestContext, requestOptions, key)

Deprecated  Use an overload with DisplayLabelRequestOptions

Retrieves display label definition of specific item

getDisplayLabelDefinition(requestContext: ClientRequestContext, requestOptions: LabelRequestOptions<IModelDb>, key: InstanceKey): Promise<LabelDefinition>

Parameter Type Description
requestContext ClientRequestContext  
requestOptions LabelRequestOptions<IModelDb>  
key InstanceKey  

Returns - Promise<LabelDefinition>


Defined in

Last Updated: 11 June, 2024