HttpApiData class

Inheritance

• Object
• PrivacyBase
• HttpApiData

Annotations

• @JsonSerializable()

Constructors

HttpApiData({required String directory, HttpMethod method = HttpMethod.get, String url = '', List<HttpKeyValuePair> headers = const <HttpKeyValuePair>[], List<HttpKeyValuePair> queryParams = const <HttpKeyValuePair>[], List<HttpKeyValuePair> formFields = const <HttpKeyValuePair>[], String? body, RequestBodyType bodyType = RequestBodyType.text, required String name, String id = '', String project = '', List<VariableData> variables = const [], bool isDeleted = false, DateTime? lastUpdated, RequestBodyTextType requestBodyContentType = RequestBodyTextType.json, bool isDraft = false, DateTime? created, required Set<String>? teams, required Set<String>? users, required Map<String, Role> roles, required bool? public})

HttpApiData.fromJson(Map<String, dynamic> json)

factory

HttpApiData.private({required String directory, HttpMethod method = HttpMethod.get, String url = '', List<HttpKeyValuePair> headers = const <HttpKeyValuePair>[], List<HttpKeyValuePair> queryParams = const <HttpKeyValuePair>[], List<HttpKeyValuePair> formFields = const <HttpKeyValuePair>[], String? body, RequestBodyType bodyType = RequestBodyType.text, required String name, String id = '', String project = '', List<VariableData> variables = const [], bool isDeleted = false, DateTime? lastUpdated, RequestBodyTextType requestBodyContentType = RequestBodyTextType.json, bool isDraft = false, DateTime? created, required PrivacyBase privacy})

Properties

body → String?

final

bodyType → RequestBodyType

final

created → DateTime

final

directory → String

final

editors → List<String>

A list of user ids that are editors of this object.

no setter, inherited

formFields → List<HttpKeyValuePair>

final

hashCode → int

The hash code for this object.

no setter, inherited

headers → List<HttpKeyValuePair>

final

id → String

final

isDeleted → bool

final

isDraft ↔ bool

getter/setter pair

lastUpdated → DateTime

final

method → HttpMethod

final

name → String

final

owners → Set<String>

An owner ID must always exist in the roles map. It's an error if it doesn't.

no setter, inherited

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 setter, inherited

project → String

final

props → List<Object?>

The list of properties that will be used to determine whether two instances are equal.

no setter, override

public → bool

Whether the object is public or not. If it is public, then it is accessible to read by anyone on the platform.

final, inherited

queryParams → List<HttpKeyValuePair>

final

requestBodyContentType → RequestBodyTextType

final

roles → Map<String, Role>

The roles of each user from the users set.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

teams → Set<String>

The list of teams associated with a particular document.

final, inherited

url → String

final

users → Set<String>

A set of user ids that are allowed to access the project in some way defined by the roles map.

final, inherited

variables → List<VariableData>

final

viewers → List<String>

A list of user ids that are viewers of this object.

no setter, inherited

Methods

copyWith({HttpMethod? method, String? url, List<HttpKeyValuePair>? headers, List<HttpKeyValuePair>? queryParams, List<HttpKeyValuePair>? formFields, List<VariableData>? variables, String? body, String? name, String? id, String? project, bool? isDeleted, DateTime? lastUpdated, DateTime? created, RequestBodyType? bodyType, RequestBodyTextType? requestBodyContentType, bool? isDraft, String? directory, bool forceDirectory = false, PrivacyBase? privacy}) → HttpApiData

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Returns a serializable map representation of the object.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited