FrameworkApi class

Constructors

FrameworkApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

deleteFrameworkByDoctypeByName(String doctype, String name) → Future<void>
Removes one document, after its on_trash hooks agree.
deleteFrameworkByDoctypeByNameWithHttpInfo(String doctype, String name) → Future<Response>
Removes one document, after its on_trash hooks agree.
deleteFrameworkDoctypesByName(String name) → Future<void>
Removes a DocType and every document stored under it.
deleteFrameworkDoctypesByNameWithHttpInfo(String name) → Future<Response>
Removes a DocType and every document stored under it.
deleteFrameworkRolesByUserByRole(String user, String role) → Future<void>
Removes one (user, role) grant in the caller's org.
deleteFrameworkRolesByUserByRoleWithHttpInfo(String user, String role) → Future<Response>
Removes one (user, role) grant in the caller's org.
getFrameworkByDoctype(String doctype, {String? filters, String? fields, String? orderBy, String? limit}) → Future<DocumentList?>
Returns the caller org's documents of one DocType, filtered, ordered and projected by the query.
getFrameworkByDoctypeByName(String doctype, String name) → Future<Map<String, Object>?>
Returns one document by name, with Password fields redacted.
getFrameworkByDoctypeByNameWithHttpInfo(String doctype, String name) → Future<Response>
Returns one document by name, with Password fields redacted.
getFrameworkByDoctypeWithHttpInfo(String doctype, {String? filters, String? fields, String? orderBy, String? limit}) → Future<Response>
Returns the caller org's documents of one DocType, filtered, ordered and projected by the query.
getFrameworkDoctypes() → Future<DocTypeList?>
Returns every DocType defined in the caller's org.
getFrameworkDoctypesByName(String name) → Future<DocType?>
Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags.
getFrameworkDoctypesByNameWithHttpInfo(String name) → Future<Response>
Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags.
getFrameworkDoctypesWithHttpInfo() → Future<Response>
Returns every DocType defined in the caller's org.
getFrameworkModules() → Future<ModuleList?>
Returns every app lane compiled into this deployment and the DocTypes each one installs.
getFrameworkModulesByModule(String module) → Future<ModuleState?>
Returns one app lane's install state for the caller's org: the DocTypes the lane declares, and which of them already exist in the org.
getFrameworkModulesByModuleWithHttpInfo(String module) → Future<Response>
Returns one app lane's install state for the caller's org: the DocTypes the lane declares, and which of them already exist in the org.
getFrameworkModulesWithHttpInfo() → Future<Response>
Returns every app lane compiled into this deployment and the DocTypes each one installs.
getFrameworkRoles() → Future<RoleList?>
Returns every (user, role) assignment in the caller's org.
getFrameworkRolesWithHttpInfo() → Future<Response>
Returns every (user, role) assignment in the caller's org.
getFrameworkSummary() → Future<SummaryView?>
Reports how much of the DocType surface the caller's org uses: how many DocTypes it has defined, and how many documents exist across them.
getFrameworkSummaryWithHttpInfo() → Future<Response>
Reports how much of the DocType surface the caller's org uses: how many DocTypes it has defined, and how many documents exist across them.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postFrameworkByDoctype(String doctype) → Future<void>
Create one document of a DocType, from that DocType's own fields.
postFrameworkByDoctypeByNameCancel(String doctype, String name) → Future<Map<String, Object>?>
Moves a submitted document to cancelled (docstatus 1 → 2) after its on_cancel hooks agree.
postFrameworkByDoctypeByNameCancelWithHttpInfo(String doctype, String name) → Future<Response>
Moves a submitted document to cancelled (docstatus 1 → 2) after its on_cancel hooks agree.
postFrameworkByDoctypeByNameSubmit(String doctype, String name) → Future<Map<String, Object>?>
Moves a draft to submitted (docstatus 0 → 1) after its on_submit hooks agree.
postFrameworkByDoctypeByNameSubmitWithHttpInfo(String doctype, String name) → Future<Response>
Moves a draft to submitted (docstatus 0 → 1) after its on_submit hooks agree.
postFrameworkByDoctypeWithHttpInfo(String doctype) → Future<Response>
Create one document of a DocType, from that DocType's own fields.
postFrameworkDoctypes(DocType docType) → Future<DocType?>
Defines a DocType in the caller's org: the metadata that gives a document surface its fields, its naming rule, whether it has a submit/cancel lifecycle, and which role may do what to it.
postFrameworkDoctypesWithHttpInfo(DocType docType) → Future<Response>
Defines a DocType in the caller's org: the metadata that gives a document surface its fields, its naming rule, whether it has a submit/cancel lifecycle, and which role may do what to it.
postFrameworkModulesByModuleInstall(String module) → Future<Install?>
Creates an app lane's DocTypes in the caller's org.
postFrameworkModulesByModuleInstallWithHttpInfo(String module) → Future<Response>
Creates an app lane's DocTypes in the caller's org.
postFrameworkRoles(RoleAssignment roleAssignment) → Future<RoleAssignment?>
Grants one user one role in the caller's org — how a member gains rights on a DocType, since permissions name roles and never users.
postFrameworkRolesWithHttpInfo(RoleAssignment roleAssignment) → Future<Response>
Grants one user one role in the caller's org — how a member gains rights on a DocType, since permissions name roles and never users.
putFrameworkByDoctypeByName(String doctype, String name) → Future<void>
Replace a draft document's field data wholesale.
putFrameworkByDoctypeByNameWithHttpInfo(String doctype, String name) → Future<Response>
Replace a draft document's field data wholesale.
putFrameworkDoctypesByName(String name, DocType docType) → Future<DocType?>
Replaces a DocType definition wholesale (PUT semantics): the stored definition becomes the body.
putFrameworkDoctypesByNameWithHttpInfo(String name, DocType docType) → Future<Response>
Replaces a DocType definition wholesale (PUT semantics): the stored definition becomes the body.
toString() → String
A string representation of this object.
inherited

Operators

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