FrappeMetaController class

A controller containing properties and methods about the models (meta data) related to Frappé.

Inheritance

Constructors

FrappeMetaController(RenovationConfig config)

Properties

config → RenovationConfig
finalinherited
docTypeCache ↔ Map<String?, DocType>
Holds the doctype's in the cache
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

clearCache() → void
Clears all docMeta from the cache
override
getCore() → Renovation
Gets the reference to the Renovation instance
inherited
getDocCount({required String doctype, dynamic filters}) → Future<RequestResponse<int?>>
Returns the number of documents of a doctype available in the backend within RequestResponse.
override
getDocInfo({required String? doctype, required String docname}) → Future<RequestResponse<FrappeDocInfo?>>
Returns information about a document docname of type doctype defined by FrappeDocInfo.
override
getDocMeta({required String? doctype}) → Future<RequestResponse<DocType?>>
Returns the meta about a certain doctype based on the definition of Frappé's DocType.
override
getFieldLabel({required String doctype, required String fieldName}) → Future<String?>
Returns the label of a field in Frappé.
override
getHostUrl() → String
Returns the configured host URL towards the backend
inherited
getReportMeta({required String report}) → Future<RequestResponse<RenovationReport?>>
Returns the meta details of a Frappé report as a RenovationReport.
override
handleError(String? errorId, ErrorDetail? error) → ErrorDetail
Returns the ErrorDetail after manipulating an existing one.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited