SDKPublishModel class

A model that represents the collection of published layouts.

This class also holds common data that is shared across all layouts.

Inheritance
Annotations
  • @JsonSerializable()

Constructors

SDKPublishModel({required String projectId, SDKPublishUpdates? updates, List<String>? pages, Map<String, String>? layoutIDMap, LookupMap<SDKPublishFont>? fonts, LookupMap<SDKPublishLayout>? layouts, LookupMap<SDKLayoutVariables>? variables, LookupMap<SDKLayoutConditions>? conditions, Map<String, HttpApiData>? apis, String? entryLayoutId, String? entryPageId, String? entryCanvasId, DateTime? lastUpdated, required Set<String>? teams, required Set<String>? users, required Map<String, Role> roles, required bool? public})
Creates a new instance of SDKPublishModel.
SDKPublishModel.fromJson(Map<String, dynamic> json)
Creates a new instance of SDKPublishModel from a JSON map.
factory
SDKPublishModel.private({required String projectId, SDKPublishUpdates? updates, List<String>? pages, Map<String, String>? layoutIDMap, Map<String, SDKPublishFont>? fonts, Map<String, SDKPublishLayout>? layouts, Map<String, SDKLayoutVariables>? variables, Map<String, SDKLayoutConditions>? conditions, Map<String, HttpApiData>? apis, String? entryLayoutId, String? entryPageId, String? entryCanvasId, DateTime? lastUpdated, required PrivacyBase privacy})
Creates a new instance of SDKPublishModel with privacy inherited from another PrivacyBase.

Properties

apis → Map<String, HttpApiData>
A map of apiId -> HttpApiData.
final
conditions → LookupMap<SDKLayoutConditions>
Contains information about the conditions used in the published project.
final
editors → List<String>
A list of user ids that are editors of this object.
no setterinherited
entryCanvasId → String?
The id of the canvas that should be used as the entry point when viewing from site.codelessly.com or the Codelessly template gallery.
final
entryLayoutId → String?
The id of the layout that should be used as the entry point when viewing from site.codelessly.com or the Codelessly template gallery.
final
entryPageId → String?
The id of the page that should be used as the entry point when viewing from site.codelessly.com or the Codelessly template gallery.
final
fonts → LookupMap<SDKPublishFont>
A lazily loaded map of fonts. This map is populated during initialization of the SDK.
final
hashCode → int
The hash code for this object.
no setterinherited
lastUpdated → DateTime
final
layoutIDMap → Map<String, String>
This map is a map of CustomLayoutID -> OriginalLayoutID.
final
layouts → LookupMap<SDKPublishLayout>
A lazily loaded map of layouts. This map is populated during initialization of the SDK.
final
owners → Set<String>
An owner ID must always exist in the roles map. It's an error if it doesn't.
no setterinherited
pages → List<String>
A list containing all of the pages that contain any of the layouts in layouts map.
final
privacy → PrivacyBaseImpl
While this PrivacyBase object is extended by other models, calling toJson on those models will return data in addition to these core privacy properties.
no setterinherited
projectId → String
The project's id.
final
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setteroverride
public → bool
Whether the object is public or not. If it is public, then it is accessible to read by anyone on the platform.
finalinherited
roles → Map<String, Role>
The roles of each user from the users set.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
teams → Set<String>
The list of teams associated with a particular document.
finalinherited
updates → SDKPublishUpdates
Contains information about the state of the published project. This is used to determine whether fonts and layouts should be updated.
final
users → Set<String>
A set of user ids that are allowed to access the project in some way defined by the roles map.
finalinherited
variables → LookupMap<SDKLayoutVariables>
Contains information about the variables used in the published project.
final
viewers → List<String>
A list of user ids that are viewers of this object.
no setterinherited

Methods

copyWith({String? projectId, List<String>? pages, SDKPublishUpdates? updates, Map<String, String>? layoutIDMap, Map<String, SDKPublishFont>? fonts, Map<String, SDKPublishLayout>? layouts, Map<String, HttpApiData>? apis, Map<String, SDKLayoutVariables>? variables, Map<String, SDKLayoutConditions>? conditions, String? entryLayoutId, String? entryPageId, String? entryCanvasId, DateTime? lastUpdated, PrivacyBase? privacy}) → SDKPublishModel
Creates a copy of this instance with the provided parameters.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toFullJson() → Map<String, dynamic>
Converts this instance to a JSON map.
toJson() → Map<String, dynamic>
Converts this instance to a JSON map without the fonts, layouts, and apis.
toString() → String
A string representation of this object.
inherited

Operators

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