SDKPublishLayout class

Inheritance
Annotations
  • @JsonSerializable()

Constructors

SDKPublishLayout({required String id, required String pageId, required String projectId, required Map<String, Map<String, BaseNode>> canvases, required DateTime lastUpdated, List<Breakpoint>? breakpoints, required Set<String>? teams, required Set<String>? users, required Map<String, Role> roles, required bool? public})
Creates a new instance of SDKPublishLayout.
SDKPublishLayout.fromJson(Map<String, dynamic> json)
Creates a new instance of SDKPublishLayout from a JSON map.
factory
SDKPublishLayout.private({required String id, required String pageId, required String projectId, required Map<String, Map<String, BaseNode>> canvases, required DateTime lastUpdated, List<Breakpoint>? breakpoints, required PrivacyBase privacy})
Creates a new instance of SDKPublishLayout with privacy inherited from another PrivacyBase.

Properties

breakpoints List<Breakpoint>
final
canvases Map<String, Map<String, BaseNode>>
A list of the nodes that makes up this layout. CanvasID -> <NodeID -> Node>
final
canvasIds Set<String>
Extracted canvas ids from the canvases map. This is available for convenience. Do not modify this set directly.
final
editors List<String>
A list of user ids that are editors of this object.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
id String
The layout's unique id.
final
isExpired bool
Returns true if the layout is expired.
no setter
lastUpdated DateTime
The last time this layout was updated. Used for cache validation.
final
owners Set<String>
An owner ID must always exist in the roles map. It's an error if it doesn't.
no setterinherited
pageId String
The layout's page id.
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 layout's project 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
users Set<String>
A set of user ids that are allowed to access the project in some way defined by the roles map.
finalinherited
viewers List<String>
A list of user ids that are viewers of this object.
no setterinherited

Methods

copyWith({String? id, String? pageId, String? projectId, Map<String, Map<String, BaseNode>>? canvases, DateTime? lastUpdated, List<Breakpoint>? breakpoints, PrivacyBase? privacy}) SDKPublishLayout
Creates a copy of this instance with the provided parameters.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Converts this instance to a JSON map.
toString() String
A string representation of this object.
inherited

Operators

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