FlutterRestorationPlugin Class Reference

#include <FlutterRestorationPlugin.h>

Inheritance diagram for FlutterRestorationPlugin:

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithChannel:restorationEnabled:
(void)	- markRestorationComplete
(void)	- reset
(void)	- handleMethodCall:result: [implementation]
(void)	- setRestorationData: [implementation]
(NSDictionary *)	- dataForFramework [implementation]

Class Methods
(instancetype)	+ NS_UNAVAILABLE

Properties
NSData *	restorationData
FlutterResult	pendingRequest [implementation]

Detailed Description

Definition at line 12 of file FlutterRestorationPlugin.h.

Method Documentation

dataForFramework

- (NSDictionary *) dataForFramework

implementation

Definition at line 20 of file FlutterRestorationPlugin.mm.

                                  {
  if (!_restorationEnabled) {
    return @{@"enabled" : @NO};
  }
  if (self.restorationData == nil) {
    return @{@"enabled" : @YES};
  }
  return @{
    @"enabled" : @YES,
    @"data" : [FlutterStandardTypedData typedDataWithBytes:self.restorationData]
  };
}

handleMethodCall:result:

- (void) handleMethodCall: (FlutterMethodCall*)  call result: (FlutterResult)  result

implementation

Definition at line 20 of file FlutterRestorationPlugin.mm.

                        :(FlutterMethodCall*)call result:(FlutterResult)result {
  if ([[call method] isEqualToString:@"put"]) {
    NSAssert(self.pendingRequest == nil, @"Cannot put data while a get request is pending.");
    FlutterStandardTypedData* data = [call arguments];
    self.restorationData = [data data];
    result(nil);
  } else if ([[call method] isEqualToString:@"get"]) {
    if (!_restorationEnabled || !_waitForData) {
      result([self dataForFramework]);
      return;
    }
    NSAssert(self.pendingRequest == nil, @"There can only be one pending request.");
    self.pendingRequest = result;
  } else {
    result(FlutterMethodNotImplemented);
  }
}

initWithChannel:restorationEnabled:

- (instancetype) initWithChannel:		(FlutterMethodChannel*)	channel
restorationEnabled:		(BOOL)	NS_DESIGNATED_INITIALIZER

Definition at line 20 of file FlutterRestorationPlugin.mm.

                               :(FlutterMethodChannel*)channel
             restorationEnabled:(BOOL)restorationEnabled {
  FML_DCHECK(channel) << "channel must be set";
  self = [super init];
  if (self) {
    [channel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
      [self handleMethodCall:call result:result];
    }];
    _restorationEnabled = restorationEnabled;
    _waitForData = restorationEnabled;
  }
  return self;
}

markRestorationComplete

- (void) markRestorationComplete

Definition at line 20 of file FlutterRestorationPlugin.mm.

                                {
  _waitForData = NO;
  if (self.pendingRequest != nil) {
    NSAssert(_restorationEnabled, @"No request can be pending when restoration is disabled.");
    self.pendingRequest([self dataForFramework]);
    self.pendingRequest = nil;
  }
}

NS_UNAVAILABLE [1/2]

- (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE [2/2]

+ (instancetype) NS_UNAVAILABLE

reset

- (void) reset

Definition at line 20 of file FlutterRestorationPlugin.mm.

              {
  self.pendingRequest = nil;
  self.restorationData = nil;
}

setRestorationData:

- (void) setRestorationData: (NSData*)  data

implementation

Definition at line 20 of file FlutterRestorationPlugin.mm.

                          :(NSData*)data {
  if (data != _restorationData) {
    _restorationData = [data copy];
  }
  _waitForData = NO;
  if (self.pendingRequest != nil) {
    self.pendingRequest([self dataForFramework]);
    self.pendingRequest = nil;
  }
}

Property Documentation

pendingRequest

- (FlutterResult) pendingRequest

readwritenonatomiccopyimplementation

Provided by category FlutterRestorationPlugin().

Definition at line 15 of file FlutterRestorationPlugin.mm.

restorationData

- (NSData*) restorationData

readwritenonatomiccopy

Definition at line 18 of file FlutterRestorationPlugin.h.

---

The documentation for this class was generated from the following files:

• shell/platform/darwin/ios/framework/Source/FlutterRestorationPlugin.h
• shell/platform/darwin/ios/framework/Source/FlutterRestorationPlugin.mm