Subscription<TParsed> class

Creats a subscription with GraphQLClient.subscribe.

The builder is passed a QueryResult with only the most recent data. ResultAccumulator can be used to accumulate results.

onSubscriptionResult can be used to react to changes, and has access to the client.

{@tool snippet}

Excerpt from the starwars example using ResultAccumulator

class ReviewFeed extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Subscription(
      options: SubscriptionOptions(
        document: gql(
          r'''
            subscription reviewAdded {
              reviewAdded {
                stars, commentary, episode
              }
            }
          ''',
        ),
      ),
      builder: (result) {
        if (result.hasException) {
          return Text(result.exception.toString());
        }

        if (result.isLoading) {
          return Center(
            child: const CircularProgressIndicator(),
          );
        }
        return ResultAccumulator.appendUniqueEntries(
          latest: result.data,
          builder: (context, {results}) => DisplayReviews(
            reviews: results.reversed.toList(),
          ),
        );
      },
    );
  }
}

{@end-tool}

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• Subscription

Constructors

Subscription({required SubscriptionOptions<TParsed> options, required SubscriptionBuilder<TParsed> builder, OnSubscriptionResult<TParsed>? onSubscriptionResult, Key? key})

const

Properties

builder → SubscriptionBuilder<TParsed>

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

onSubscriptionResult → OnSubscriptionResult<TParsed>?

final

options → SubscriptionOptions<TParsed>

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget.

override

createElement() → _StatelessHookElement

Creates a StatelessElement to manage this widget's location in the tree.

inherited

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited