FFNavigateAction class

Inheritance
Available extensions

Constructors

FFNavigateAction({@Deprecated('This field is deprecated.') String? legacyPageName, bool? allowBack, FFPassedParameters? passedParameters, bool? isNavigateBack, FFNavigateTransition? transition, bool? ignoreRedirects, bool? closeDialog, bool? replaceRoute, bool? navigateToRootPageOnFailure, @Deprecated('This field is deprecated.') String? legacyPageNodeKey, FFNodeKeyReference? pageNodeKeyRef})
factory
FFNavigateAction.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
FFNavigateAction.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

allowBack ↔ bool
@doc Whether to allow back navigation.
getter/setter pair
closeDialog ↔ bool
@doc Used to close any dialog, drawer, etc. This calls "Navigator.pop" in all cases, unlike "navigate back" which calls "context.pop" when deep linking.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
ignoreRedirects ↔ bool
  • getter/setter pair
    info_ → BuilderInfo
    no setteroverride
    isFrozen → bool
    Returns true if this message is marked read-only. Otherwise false.
    no setterinherited
    isNavigateBack ↔ bool
    @doc Whether to navigate back.
    getter/setter pair
    isNavigateToPage → bool

    Available on FFNavigateAction, provided by the SchemaNavigateExtensions extension

    no setter
    legacyPageName ↔ String
    getter/setter pair
    legacyPageNodeKey ↔ String
    getter/setter pair
    @doc If routing is enabled and cannot pop, instead go to the root page.
    getter/setter pair
    pageNodeKeyRef ↔ FFNodeKeyReference
    @doc The node key reference to the page to navigate to.
    getter/setter pair
    passedParameters ↔ FFPassedParameters
    @doc The parameters to pass to the page when navigating.
    getter/setter pair
    replaceRoute ↔ bool
    @doc Whether to replace the current route during navigation. i.e. whether to use Navigator.pushReplacement.
    getter/setter pair
    runtimeType → Type
    A representation of the runtime type of the object.
    no setterinherited
    transition ↔ FFNavigateTransition
    @doc How to transition between pages.
    getter/setter pair
    unknownFields → UnknownFieldSet
    no setterinherited

    Methods

    addExtension(Extension extension, Object? value) → void
    Adds an extension field value to a repeated field.
    inherited
    check() → void
    Throws a StateError if the message has required fields without a value.
    inherited
    clear() → void
    Clears all data that was set in this message.
    inherited
    clearAllowBack() → void
    clearCloseDialog() → void
    clearExtension(Extension extension) → void
    Clears an extension field and also removes the extension.
    inherited
    clearField(int tagNumber) → void
    Clears the contents of a given field.
    inherited
    clearIgnoreRedirects() → void
    clearIsNavigateBack() → void
    clearLegacyPageName() → void
    clearLegacyPageNodeKey() → void
    clearNavigateToRootPageOnFailure() → void
    clearPageNodeKeyRef() → void
    clearPassedParameters() → void
    clearReplaceRoute() → void
    clearTransition() → void
    clone() → FFNavigateAction
    Creates a deep copy of the fields in this message.
    override
    copyWith(void updates(FFNavigateAction)) → FFNavigateAction
    Apply updates to a copy of this message.
    override
    createEmptyInstance() → FFNavigateAction
    Creates an empty instance of the same message type as this.
    override
    deepCopy() → T

    Available on T, provided by the GeneratedMessageGenericExtensions extension

    Returns a writable deep copy of this message.
    ensurePageNodeKeyRef() → FFNodeKeyReference
    ensurePassedParameters() → FFPassedParameters
    ensureTransition() → FFNavigateTransition
    extensionsAreInitialized() → bool
    inherited
    freeze() → GeneratedMessage
    Make this message read-only.
    inherited
    fromCompressedSerializedBuffer(List<int> buffer, [int recursionLimit = 512]) → void

    Available on GeneratedMessage, provided by the SchemaCompressedSerializationExtensions extension

    fromCompressedSerializedBufferString(String buffer, [int recursionLimit = 512]) → void

    Available on GeneratedMessage, provided by the SchemaCompressedSerializationExtensions extension

    getDefaultForField(int tagNumber) → dynamic
    Returns the default value for the given field.
    inherited
    getExtension(Extension extension) → dynamic
    Returns the value of extension.
    inherited
    getField(int tagNumber) → dynamic
    Returns the value of the field associated with tagNumber, or the default value if it is not set.
    inherited
    getFieldOrNull(int tagNumber) → dynamic
    Returns the value of a field, ignoring any defaults.
    inherited
    getTagNumber(String fieldName) → int?
    inherited
    hasAllowBack() → bool
    hasCloseDialog() → bool
    hasExtension(Extension extension) → bool
    Returns true if a value of extension is present.
    inherited
    hasField(int tagNumber) → bool
    Whether this message has a field associated with tagNumber.
    inherited
    hasIgnoreRedirects() → bool
    hasIsNavigateBack() → bool
    hasLegacyPageName() → bool
    hasLegacyPageNodeKey() → bool
    hasNavigateToRootPageOnFailure() → bool
    hasPageNodeKeyRef() → bool
    hasPassedParameters() → bool
    hasReplaceRoute() → bool
    hasRequiredFields() → bool
    Whether the message has required fields.
    inherited
    hasTransition() → bool
    isInitialized() → bool
    Whether all required fields in the message and embedded messages are set.
    inherited
    mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
    Merges serialized protocol buffer data into this message.
    inherited
    mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
    Same as mergeFromBuffer, but takes a CodedBufferReader input.
    inherited
    mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
    Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
    inherited
    mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
    Merges field values from a JSON object represented as a Dart map.
    inherited
    mergeFromMessage(GeneratedMessage other) → void
    Merges the contents of the other into this message.
    inherited
    mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
    Merges field values from json, a JSON object using proto3 encoding.
    inherited
    mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
    inherited
    noSuchMethod(Invocation invocation) → dynamic
    Invoked when a nonexistent method or property is accessed.
    inherited
    rebuild(void updates(T)) → T

    Available on T, provided by the GeneratedMessageGenericExtensions extension

    Apply updates to a copy of this message.
    setExtension(Extension extension, Object value) → void
    Sets the value of a non-repeated extension field to value.
    inherited
    setField(int tagNumber, Object value) → void
    Sets the value of a field by its tagNumber.
    inherited
    toBuilder() → GeneratedMessage
    Creates a writable, shallow copy of this message.
    inherited
    toDebugString() → String
    Returns a String representation of this message.
    inherited
    toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
    Returns an Object representing Proto3 JSON serialization of this.
    inherited
    toString() → String
    Returns a String representation of this message.
    inherited
    toTextFormat() → String

    Available on GeneratedMessage, provided by the TextFormatExtension extension

    Returns a TextFormat String representation of this message.
    writeTextFormat(StringSink sink) → void

    Available on GeneratedMessage, provided by the TextFormatExtension extension

    Writes a TextFormat String representation of this message to sink.
    writeToBuffer() → Uint8List
    Serialize the message as the protobuf binary format.
    inherited
    writeToCodedBufferWriter(CodedBufferWriter output) → void
    Same as writeToBuffer, but serializes to the given CodedBufferWriter.
    inherited
    writeToJson() → String
    Returns a JSON string that encodes this message.
    inherited
    writeToJsonMap() → Map<String, dynamic>
    Returns the JSON encoding of this message as a Dart Map.
    inherited

    Operators

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

    Static Methods

    create() → FFNavigateAction
    getDefault() → FFNavigateAction